le_bootReason_interface.h File Reference

#include "legato.h"

Go to the source code of this file.

Functions
void	le_bootReason_ConnectService (void)
void	le_bootReason_DisconnectService (void)
bool	le_bootReason_WasTimer (void)
bool	le_bootReason_WasGpio (uint32_t gpioNum)

Detailed Description

Legato Boot Reason Query include file.

Copyright (C) Sierra Wireless Inc. Use of this work is subject to license.

Function Documentation

void le_bootReason_ConnectService

(

void

)

Connect the current client thread to the service providing this API.

This function must be called before any other functions in this API. Normally, it's automatically called for the main thread, but must be explicitly called for other threads. For details, see Client-specific Functions.

This function is created automatically.

void le_bootReason_DisconnectService

(

void

)

Disconnect the current client thread from the service providing this API.

Normally, this function doesn't need to be called. After this function is called, there's no longer a connection to the service, and the functions in this API can't be used. For details, see Client-specific Functions.

This function is created automatically.

bool le_bootReason_WasGpio

(

uint32_t

gpioNum

)

Checks whether boot-reason was specific gpio change. GPIO number is specified in parameter.

Returns

• TRUE if boot-reason was specified gpio change.
• FALSE otherwise.

Note

The process exits if invalid gpio number is passed. Check corresponding device documents for valid list of gpio.

Parameters

[in]

gpioNum

GPIO number.

bool le_bootReason_WasTimer

(

void

)

Checks whether boot-reason was timer expiry.

Returns

• TRUE if boot-reason was timer expiry.
• FALSE otherwise.