ACU6 Device API
Data Structures | Enumerations | Enumerator | Functions
ipc_power

Power Service. More...

Data Structures

struct  a_ipc_dyn_array_enum_power_result
 Dynamic-length array of a_ipc_enum_power_result. More...
 
struct  a_ipc_msg_power_request_req
 Requests power for user 'user'. More...
 
struct  a_ipc_msg_power_request_rsp
 Power request result. More...
 
struct  a_ipc_msg_power_release_req_norsp
 Release power for given user user. More...
 
struct  a_ipc_msg_power_suspend_register_req
 Registers an "suspend interest" with the power manager. More...
 
struct  a_ipc_msg_power_suspend_register_rsp
 Respons message to the 'power_suspend_register_req' message. More...
 
struct  a_ipc_msg_power_suspend_unregister_req_norsp
 Un-registers a 'suspend interest' with the power manager. More...
 
struct  a_ipc_msg_power_suspend_publish_ind
 Power suspend indication, sent by the power manager when we are about to enter sleep mode. More...
 
struct  a_ipc_msg_power_suspend_ack_req_norsp
 Sent by subscribers of the suspend message to acknowledge that their pre-suspend activities have completed. More...
 
struct  a_ipc_msg_power_shutdown_register_req
 Registers an "shutdown interest" with the power manager. More...
 
struct  a_ipc_msg_power_shutdown_register_rsp
 Respons message to the 'power_shutdown_register_req' message. More...
 
struct  a_ipc_msg_power_shutdown_unregister_req_norsp
 Un-registers a 'shutdown interest' with the power manager. More...
 
struct  a_ipc_msg_power_shutdown_publish_ind
 Power shutdown indication, sent by the power manager when we are about to shutdown. More...
 
struct  a_ipc_msg_power_shutdown_ack_req_norsp
 Sent by subscribers of the shutdown message to acknowledge that their pre-shutdown activities have completed. More...
 
struct  a_ipc_msg_power_shutdown_shutdown_req_norsp
 Shutdown the system as soon as possible. More...
 
struct  a_ipc_msg_power_shutdown_reboot_req_norsp
 Reboot the system as soon as possible. More...
 
struct  a_ipc_msg_power_reboot_pending_publish_ind
 A reboot is pending and if no voluntary reboot is made, the system will after some time perform a forced reboot. More...
 
struct  a_ipc_msg_power_wakeup_publish_ind
 Power wakeup indication, sent by the power manager when services should wake up from their sleep state. More...
 
struct  a_ipc_msg_power_get_no_of_requestors_req
 Requests the number of 'clients' requesting the system to be powered on. More...
 
struct  a_ipc_msg_power_get_no_of_requestors_rsp
 Response message to the 'power_get_no_of_requestors' message. More...
 
struct  a_ipc_msg_power_get_requestor_info_req
 Get a string representation of a perticular requestor. More...
 
struct  a_ipc_msg_power_get_requestor_info_rsp
 Response message to 'power_get_requestor_info_req'. More...
 
struct  a_ipc_msg_power_suspend_unsubscribe_req_norsp
 Unsubscribe from updates for power_suspend. More...
 
struct  a_ipc_msg_power_shutdown_unsubscribe_req_norsp
 Unsubscribe from updates for power_shutdown. More...
 
struct  a_ipc_msg_power_reboot_pending_unsubscribe_req_norsp
 Unsubscribe from updates for power_reboot_pending. More...
 
struct  a_ipc_msg_power_wakeup_unsubscribe_req_norsp
 Unsubscribe from updates for power_wakeup. More...
 

Enumerations

enum  a_ipc_enum_power_result { A_IPC_ENUM_POWER_RESULT_OK , A_IPC_ENUM_POWER_RESULT_ERROR }
 Result codes. More...
 

Functions

A_IPC_RESULT a_ipc_init_power_request_req (a_ipc_msg *msg, uint32_t user_maxlength)
 Initialize the message buffer to contain a_ipc_msg_power_request_req. More...
 
A_IPC_RESULT a_ipc_init_power_request_rsp (a_ipc_msg *msg)
 Initialize the message buffer to contain a_ipc_msg_power_request_rsp. More...
 
A_IPC_RESULT a_ipc_init_power_release_req_norsp (a_ipc_msg *msg, uint32_t user_maxlength)
 Initialize the message buffer to contain a_ipc_msg_power_release_req_norsp. More...
 
A_IPC_RESULT a_ipc_init_power_suspend_register_req (a_ipc_msg *msg, uint32_t user_maxlength)
 Initialize the message buffer to contain a_ipc_msg_power_suspend_register_req. More...
 
A_IPC_RESULT a_ipc_init_power_suspend_register_rsp (a_ipc_msg *msg)
 Initialize the message buffer to contain a_ipc_msg_power_suspend_register_rsp. More...
 
A_IPC_RESULT a_ipc_init_power_suspend_unregister_req_norsp (a_ipc_msg *msg, uint32_t user_maxlength)
 Initialize the message buffer to contain a_ipc_msg_power_suspend_unregister_req_norsp. More...
 
A_IPC_RESULT a_ipc_init_power_suspend_publish_ind (a_ipc_msg *msg)
 Initialize the message buffer to contain a_ipc_msg_power_suspend_publish_ind. More...
 
A_IPC_RESULT a_ipc_init_power_suspend_ack_req_norsp (a_ipc_msg *msg, uint32_t user_maxlength)
 Initialize the message buffer to contain a_ipc_msg_power_suspend_ack_req_norsp. More...
 
A_IPC_RESULT a_ipc_init_power_shutdown_register_req (a_ipc_msg *msg, uint32_t user_maxlength)
 Initialize the message buffer to contain a_ipc_msg_power_shutdown_register_req. More...
 
A_IPC_RESULT a_ipc_init_power_shutdown_register_rsp (a_ipc_msg *msg)
 Initialize the message buffer to contain a_ipc_msg_power_shutdown_register_rsp. More...
 
A_IPC_RESULT a_ipc_init_power_shutdown_unregister_req_norsp (a_ipc_msg *msg, uint32_t user_maxlength)
 Initialize the message buffer to contain a_ipc_msg_power_shutdown_unregister_req_norsp. More...
 
A_IPC_RESULT a_ipc_init_power_shutdown_publish_ind (a_ipc_msg *msg)
 Initialize the message buffer to contain a_ipc_msg_power_shutdown_publish_ind. More...
 
A_IPC_RESULT a_ipc_init_power_shutdown_ack_req_norsp (a_ipc_msg *msg, uint32_t user_maxlength)
 Initialize the message buffer to contain a_ipc_msg_power_shutdown_ack_req_norsp. More...
 
A_IPC_RESULT a_ipc_init_power_shutdown_shutdown_req_norsp (a_ipc_msg *msg)
 Initialize the message buffer to contain a_ipc_msg_power_shutdown_shutdown_req_norsp. More...
 
A_IPC_RESULT a_ipc_init_power_shutdown_reboot_req_norsp (a_ipc_msg *msg)
 Initialize the message buffer to contain a_ipc_msg_power_shutdown_reboot_req_norsp. More...
 
A_IPC_RESULT a_ipc_init_power_reboot_pending_publish_ind (a_ipc_msg *msg)
 Initialize the message buffer to contain a_ipc_msg_power_reboot_pending_publish_ind. More...
 
A_IPC_RESULT a_ipc_init_power_wakeup_publish_ind (a_ipc_msg *msg)
 Initialize the message buffer to contain a_ipc_msg_power_wakeup_publish_ind. More...
 
A_IPC_RESULT a_ipc_init_power_get_no_of_requestors_req (a_ipc_msg *msg)
 Initialize the message buffer to contain a_ipc_msg_power_get_no_of_requestors_req. More...
 
A_IPC_RESULT a_ipc_init_power_get_no_of_requestors_rsp (a_ipc_msg *msg)
 Initialize the message buffer to contain a_ipc_msg_power_get_no_of_requestors_rsp. More...
 
A_IPC_RESULT a_ipc_init_power_get_requestor_info_req (a_ipc_msg *msg)
 Initialize the message buffer to contain a_ipc_msg_power_get_requestor_info_req. More...
 
A_IPC_RESULT a_ipc_init_power_get_requestor_info_rsp (a_ipc_msg *msg, uint32_t requestor_id_maxlength)
 Initialize the message buffer to contain a_ipc_msg_power_get_requestor_info_rsp. More...
 
A_IPC_RESULT a_ipc_init_power_suspend_subscribe_req (a_ipc_msg *msg)
 Initialize the message buffer to contain a_ipc_msg_power_suspend_subscribe_req. More...
 
A_IPC_RESULT a_ipc_init_power_suspend_subscribe_rsp (a_ipc_msg *msg)
 Initialize the message buffer to contain a_ipc_msg_power_suspend_subscribe_rsp. More...
 
A_IPC_RESULT a_ipc_init_power_suspend_unsubscribe_req_norsp (a_ipc_msg *msg)
 Initialize the message buffer to contain a_ipc_msg_power_suspend_unsubscribe_req_norsp. More...
 
A_IPC_RESULT a_ipc_init_power_shutdown_subscribe_req (a_ipc_msg *msg)
 Initialize the message buffer to contain a_ipc_msg_power_shutdown_subscribe_req. More...
 
A_IPC_RESULT a_ipc_init_power_shutdown_subscribe_rsp (a_ipc_msg *msg)
 Initialize the message buffer to contain a_ipc_msg_power_shutdown_subscribe_rsp. More...
 
A_IPC_RESULT a_ipc_init_power_shutdown_unsubscribe_req_norsp (a_ipc_msg *msg)
 Initialize the message buffer to contain a_ipc_msg_power_shutdown_unsubscribe_req_norsp. More...
 
A_IPC_RESULT a_ipc_init_power_reboot_pending_subscribe_req (a_ipc_msg *msg)
 Initialize the message buffer to contain a_ipc_msg_power_reboot_pending_subscribe_req. More...
 
A_IPC_RESULT a_ipc_init_power_reboot_pending_subscribe_rsp (a_ipc_msg *msg)
 Initialize the message buffer to contain a_ipc_msg_power_reboot_pending_subscribe_rsp. More...
 
A_IPC_RESULT a_ipc_init_power_reboot_pending_unsubscribe_req_norsp (a_ipc_msg *msg)
 Initialize the message buffer to contain a_ipc_msg_power_reboot_pending_unsubscribe_req_norsp. More...
 
A_IPC_RESULT a_ipc_init_power_wakeup_subscribe_req (a_ipc_msg *msg)
 Initialize the message buffer to contain a_ipc_msg_power_wakeup_subscribe_req. More...
 
A_IPC_RESULT a_ipc_init_power_wakeup_subscribe_rsp (a_ipc_msg *msg)
 Initialize the message buffer to contain a_ipc_msg_power_wakeup_subscribe_rsp. More...
 
A_IPC_RESULT a_ipc_init_power_wakeup_unsubscribe_req_norsp (a_ipc_msg *msg)
 Initialize the message buffer to contain a_ipc_msg_power_wakeup_unsubscribe_req_norsp. More...
 

Detailed Description

Power Service.

This page contains documentation of the Power Service API.


Data Structure Documentation

◆ a_ipc_dyn_array_enum_power_result

struct a_ipc_dyn_array_enum_power_result

Dynamic-length array of a_ipc_enum_power_result.

Data Fields
uint32_t length Length of the array (number of elements)
a_ipc_enum_power_result * value The contents of the array.

◆ a_ipc_msg_power_request_req

struct a_ipc_msg_power_request_req

Requests power for user 'user'.

Response is delivered in a_ipc_msg_power_request_rsp.

Create using a_ipc_init_power_request_req().

Message type is A_IPC_MSG_POWER_REQUEST_REQ.

Data Fields
a_ipc_dyn_string user User identifier, max 15 characters long.

◆ a_ipc_msg_power_request_rsp

struct a_ipc_msg_power_request_rsp

Power request result.

Sent in response to a_ipc_msg_power_request_req.

Create using a_ipc_init_power_request_rsp().

Message type is A_IPC_MSG_POWER_REQUEST_RSP.

Data Fields
a_ipc_enum_power_result result Result of the operation.

◆ a_ipc_msg_power_release_req_norsp

struct a_ipc_msg_power_release_req_norsp

Release power for given user user.

Create using a_ipc_init_power_release_req_norsp().

Message type is A_IPC_MSG_POWER_RELEASE_REQ_NORSP.

Data Fields
a_ipc_dyn_string user User identifier, max 15 characters long.

◆ a_ipc_msg_power_suspend_register_req

struct a_ipc_msg_power_suspend_register_req

Registers an "suspend interest" with the power manager.

This means that the 'client' has some activites to perform before the system can enter a suspend state.

When a client has registered a suspend interest it is expected to send and 'ack' message in response to the 'suspend_ind' message when its pre-suspend activites have completed.

Response is delivered in a_ipc_msg_power_suspend_register_rsp.

Create using a_ipc_init_power_suspend_register_req().

Message type is A_IPC_MSG_POWER_SUSPEND_REGISTER_REQ.

Data Fields
a_ipc_dyn_string user User identifier, max 15 characters long.

◆ a_ipc_msg_power_suspend_register_rsp

struct a_ipc_msg_power_suspend_register_rsp

Respons message to the 'power_suspend_register_req' message.

Sent in response to a_ipc_msg_power_suspend_register_req.

Create using a_ipc_init_power_suspend_register_rsp().

Message type is A_IPC_MSG_POWER_SUSPEND_REGISTER_RSP.

Data Fields
a_ipc_enum_power_result result Result of the operation.

◆ a_ipc_msg_power_suspend_unregister_req_norsp

struct a_ipc_msg_power_suspend_unregister_req_norsp

Un-registers a 'suspend interest' with the power manager.

Create using a_ipc_init_power_suspend_unregister_req_norsp().

Message type is A_IPC_MSG_POWER_SUSPEND_UNREGISTER_REQ_NORSP.

Data Fields
a_ipc_dyn_string user User identifier, max 15 characters long.

◆ a_ipc_msg_power_suspend_publish_ind

struct a_ipc_msg_power_suspend_publish_ind

Power suspend indication, sent by the power manager when we are about to enter sleep mode.

Subscribe using a_ipc_msg_power_suspend_subscribe_req and unsubscribe using a_ipc_msg_power_suspend_unsubscribe_req_norsp.

Create using a_ipc_init_power_suspend_publish_ind().

Message type is A_IPC_MSG_POWER_SUSPEND_PUBLISH_IND.

◆ a_ipc_msg_power_suspend_ack_req_norsp

struct a_ipc_msg_power_suspend_ack_req_norsp

Sent by subscribers of the suspend message to acknowledge that their pre-suspend activities have completed.

Create using a_ipc_init_power_suspend_ack_req_norsp().

Message type is A_IPC_MSG_POWER_SUSPEND_ACK_REQ_NORSP.

Data Fields
a_ipc_dyn_string user User identifier, max 15 characters long.

◆ a_ipc_msg_power_shutdown_register_req

struct a_ipc_msg_power_shutdown_register_req

Registers an "shutdown interest" with the power manager.

This means that the 'client' has some activites to perform before the system can shutdown.

When a client has registered a shutdown interest it is expected to send and 'ack' message in response to the 'shutdown_ind' message when its pre-suspend activites have completed.

Response is delivered in a_ipc_msg_power_shutdown_register_rsp.

Create using a_ipc_init_power_shutdown_register_req().

Message type is A_IPC_MSG_POWER_SHUTDOWN_REGISTER_REQ.

Data Fields
a_ipc_dyn_string user User identifier, max 15 characters long.

◆ a_ipc_msg_power_shutdown_register_rsp

struct a_ipc_msg_power_shutdown_register_rsp

Respons message to the 'power_shutdown_register_req' message.

Sent in response to a_ipc_msg_power_shutdown_register_req.

Create using a_ipc_init_power_shutdown_register_rsp().

Message type is A_IPC_MSG_POWER_SHUTDOWN_REGISTER_RSP.

Data Fields
a_ipc_enum_power_result result Result of the operation.

◆ a_ipc_msg_power_shutdown_unregister_req_norsp

struct a_ipc_msg_power_shutdown_unregister_req_norsp

Un-registers a 'shutdown interest' with the power manager.

Create using a_ipc_init_power_shutdown_unregister_req_norsp().

Message type is A_IPC_MSG_POWER_SHUTDOWN_UNREGISTER_REQ_NORSP.

Data Fields
a_ipc_dyn_string user User identifier, max 15 characters long.

◆ a_ipc_msg_power_shutdown_publish_ind

struct a_ipc_msg_power_shutdown_publish_ind

Power shutdown indication, sent by the power manager when we are about to shutdown.

Subscribe using a_ipc_msg_power_shutdown_subscribe_req and unsubscribe using a_ipc_msg_power_shutdown_unsubscribe_req_norsp.

Create using a_ipc_init_power_shutdown_publish_ind().

Message type is A_IPC_MSG_POWER_SHUTDOWN_PUBLISH_IND.

◆ a_ipc_msg_power_shutdown_ack_req_norsp

struct a_ipc_msg_power_shutdown_ack_req_norsp

Sent by subscribers of the shutdown message to acknowledge that their pre-shutdown activities have completed.

Create using a_ipc_init_power_shutdown_ack_req_norsp().

Message type is A_IPC_MSG_POWER_SHUTDOWN_ACK_REQ_NORSP.

Data Fields
a_ipc_dyn_string user User identifier, max 15 characters long.

◆ a_ipc_msg_power_shutdown_shutdown_req_norsp

struct a_ipc_msg_power_shutdown_shutdown_req_norsp

Shutdown the system as soon as possible.

Create using a_ipc_init_power_shutdown_shutdown_req_norsp().

Message type is A_IPC_MSG_POWER_SHUTDOWN_SHUTDOWN_REQ_NORSP.

◆ a_ipc_msg_power_shutdown_reboot_req_norsp

struct a_ipc_msg_power_shutdown_reboot_req_norsp

Reboot the system as soon as possible.

Create using a_ipc_init_power_shutdown_reboot_req_norsp().

Message type is A_IPC_MSG_POWER_SHUTDOWN_REBOOT_REQ_NORSP.

Data Fields
uint32_t delay_s Wait 'delay_s' seconds before rebooting.

◆ a_ipc_msg_power_reboot_pending_publish_ind

struct a_ipc_msg_power_reboot_pending_publish_ind

A reboot is pending and if no voluntary reboot is made, the system will after some time perform a forced reboot.

Direction: server to client

Subscribe using a_ipc_msg_power_reboot_pending_subscribe_req and unsubscribe using a_ipc_msg_power_reboot_pending_unsubscribe_req_norsp.

Create using a_ipc_init_power_reboot_pending_publish_ind().

Message type is A_IPC_MSG_POWER_REBOOT_PENDING_PUBLISH_IND.

◆ a_ipc_msg_power_wakeup_publish_ind

struct a_ipc_msg_power_wakeup_publish_ind

Power wakeup indication, sent by the power manager when services should wake up from their sleep state.

Subscribe using a_ipc_msg_power_wakeup_subscribe_req and unsubscribe using a_ipc_msg_power_wakeup_unsubscribe_req_norsp.

Create using a_ipc_init_power_wakeup_publish_ind().

Message type is A_IPC_MSG_POWER_WAKEUP_PUBLISH_IND.

◆ a_ipc_msg_power_get_no_of_requestors_req

struct a_ipc_msg_power_get_no_of_requestors_req

Requests the number of 'clients' requesting the system to be powered on.

Response is delivered in a_ipc_msg_power_get_no_of_requestors_rsp.

Create using a_ipc_init_power_get_no_of_requestors_req().

Message type is A_IPC_MSG_POWER_GET_NO_OF_REQUESTORS_REQ.

◆ a_ipc_msg_power_get_no_of_requestors_rsp

struct a_ipc_msg_power_get_no_of_requestors_rsp

Response message to the 'power_get_no_of_requestors' message.

Sent in response to a_ipc_msg_power_get_no_of_requestors_req.

Create using a_ipc_init_power_get_no_of_requestors_rsp().

Message type is A_IPC_MSG_POWER_GET_NO_OF_REQUESTORS_RSP.

Data Fields
uint32_t no_of_clients Number of 'clients' requesting the system to be powered on.
a_ipc_enum_power_result result Result of the operation.

◆ a_ipc_msg_power_get_requestor_info_req

struct a_ipc_msg_power_get_requestor_info_req

Get a string representation of a perticular requestor.

Response is delivered in a_ipc_msg_power_get_requestor_info_rsp.

Create using a_ipc_init_power_get_requestor_info_req().

Message type is A_IPC_MSG_POWER_GET_REQUESTOR_INFO_REQ.

Data Fields
uint32_t requestor_index Index of the requestor we are interested in.

◆ a_ipc_msg_power_get_requestor_info_rsp

struct a_ipc_msg_power_get_requestor_info_rsp

Response message to 'power_get_requestor_info_req'.

Sent in response to a_ipc_msg_power_get_requestor_info_req.

Create using a_ipc_init_power_get_requestor_info_rsp().

Message type is A_IPC_MSG_POWER_GET_REQUESTOR_INFO_RSP.

Data Fields
a_ipc_dyn_string requestor_id Id of the requestor.
a_ipc_enum_power_result result Result of the operation.

◆ a_ipc_msg_power_suspend_subscribe_req

struct a_ipc_msg_power_suspend_subscribe_req

Subscribe to updates for power_suspend.

a_ipc_msg_power_suspend_publish_ind will be received until a_ipc_msg_power_suspend_unsubscribe_req_norsp is sent.

Response is delivered in a_ipc_msg_power_suspend_subscribe_rsp.

Create using a_ipc_init_power_suspend_subscribe_req().

Message type is A_IPC_MSG_POWER_SUSPEND_SUBSCRIBE_REQ.

◆ a_ipc_msg_power_suspend_subscribe_rsp

struct a_ipc_msg_power_suspend_subscribe_rsp
Data Fields
a_ipc_enum_ipc_subscribe_result result The result of the subscription request.

◆ a_ipc_msg_power_suspend_unsubscribe_req_norsp

struct a_ipc_msg_power_suspend_unsubscribe_req_norsp

Unsubscribe from updates for power_suspend.

a_ipc_msg_power_suspend_publish_ind will no longer be received.

Create using a_ipc_init_power_suspend_unsubscribe_req_norsp().

Message type is A_IPC_MSG_POWER_SUSPEND_UNSUBSCRIBE_REQ_NORSP.

◆ a_ipc_msg_power_shutdown_subscribe_req

struct a_ipc_msg_power_shutdown_subscribe_req

Subscribe to updates for power_shutdown.

a_ipc_msg_power_shutdown_publish_ind will be received until a_ipc_msg_power_shutdown_unsubscribe_req_norsp is sent.

Response is delivered in a_ipc_msg_power_shutdown_subscribe_rsp.

Create using a_ipc_init_power_shutdown_subscribe_req().

Message type is A_IPC_MSG_POWER_SHUTDOWN_SUBSCRIBE_REQ.

◆ a_ipc_msg_power_shutdown_subscribe_rsp

struct a_ipc_msg_power_shutdown_subscribe_rsp
Data Fields
a_ipc_enum_ipc_subscribe_result result The result of the subscription request.

◆ a_ipc_msg_power_shutdown_unsubscribe_req_norsp

struct a_ipc_msg_power_shutdown_unsubscribe_req_norsp

Unsubscribe from updates for power_shutdown.

a_ipc_msg_power_shutdown_publish_ind will no longer be received.

Create using a_ipc_init_power_shutdown_unsubscribe_req_norsp().

Message type is A_IPC_MSG_POWER_SHUTDOWN_UNSUBSCRIBE_REQ_NORSP.

◆ a_ipc_msg_power_reboot_pending_subscribe_req

struct a_ipc_msg_power_reboot_pending_subscribe_req

◆ a_ipc_msg_power_reboot_pending_subscribe_rsp

struct a_ipc_msg_power_reboot_pending_subscribe_rsp
Data Fields
a_ipc_enum_ipc_subscribe_result result The result of the subscription request.

◆ a_ipc_msg_power_reboot_pending_unsubscribe_req_norsp

struct a_ipc_msg_power_reboot_pending_unsubscribe_req_norsp

Unsubscribe from updates for power_reboot_pending.

a_ipc_msg_power_reboot_pending_publish_ind will no longer be received.

Create using a_ipc_init_power_reboot_pending_unsubscribe_req_norsp().

Message type is A_IPC_MSG_POWER_REBOOT_PENDING_UNSUBSCRIBE_REQ_NORSP.

◆ a_ipc_msg_power_wakeup_subscribe_req

struct a_ipc_msg_power_wakeup_subscribe_req

Subscribe to updates for power_wakeup.

a_ipc_msg_power_wakeup_publish_ind will be received until a_ipc_msg_power_wakeup_unsubscribe_req_norsp is sent.

Response is delivered in a_ipc_msg_power_wakeup_subscribe_rsp.

Create using a_ipc_init_power_wakeup_subscribe_req().

Message type is A_IPC_MSG_POWER_WAKEUP_SUBSCRIBE_REQ.

◆ a_ipc_msg_power_wakeup_subscribe_rsp

struct a_ipc_msg_power_wakeup_subscribe_rsp
Data Fields
a_ipc_enum_ipc_subscribe_result result The result of the subscription request.

◆ a_ipc_msg_power_wakeup_unsubscribe_req_norsp

struct a_ipc_msg_power_wakeup_unsubscribe_req_norsp

Unsubscribe from updates for power_wakeup.

a_ipc_msg_power_wakeup_publish_ind will no longer be received.

Create using a_ipc_init_power_wakeup_unsubscribe_req_norsp().

Message type is A_IPC_MSG_POWER_WAKEUP_UNSUBSCRIBE_REQ_NORSP.

Enumeration Type Documentation

◆ a_ipc_enum_power_result

Result codes.

Enumerator
A_IPC_ENUM_POWER_RESULT_OK 

OK.

A_IPC_ENUM_POWER_RESULT_ERROR 

Error.

Function Documentation

◆ a_ipc_init_power_get_no_of_requestors_req()

A_IPC_RESULT a_ipc_init_power_get_no_of_requestors_req ( a_ipc_msg msg)

Initialize the message buffer to contain a_ipc_msg_power_get_no_of_requestors_req.

msg->info.type will be A_IPC_MSG_POWER_GET_NO_OF_REQUESTORS_REQ.

This function can be called on an already initialized message to change its type.

Parameters
msgThe message buffer to initialize

◆ a_ipc_init_power_get_no_of_requestors_rsp()

A_IPC_RESULT a_ipc_init_power_get_no_of_requestors_rsp ( a_ipc_msg msg)

Initialize the message buffer to contain a_ipc_msg_power_get_no_of_requestors_rsp.

msg->info.type will be A_IPC_MSG_POWER_GET_NO_OF_REQUESTORS_RSP.

This function can be called on an already initialized message to change its type.

Parameters
msgThe message buffer to initialize

◆ a_ipc_init_power_get_requestor_info_req()

A_IPC_RESULT a_ipc_init_power_get_requestor_info_req ( a_ipc_msg msg)

Initialize the message buffer to contain a_ipc_msg_power_get_requestor_info_req.

msg->info.type will be A_IPC_MSG_POWER_GET_REQUESTOR_INFO_REQ.

This function can be called on an already initialized message to change its type.

Parameters
msgThe message buffer to initialize

◆ a_ipc_init_power_get_requestor_info_rsp()

A_IPC_RESULT a_ipc_init_power_get_requestor_info_rsp ( a_ipc_msg msg,
uint32_t  requestor_id_maxlength 
)

Initialize the message buffer to contain a_ipc_msg_power_get_requestor_info_rsp.

msg->info.type will be A_IPC_MSG_POWER_GET_REQUESTOR_INFO_RSP.

This function can be called on an already initialized message to change its type.

Parameters
msgThe message buffer to initialize
requestor_id_maxlengthThe maximum string length for requestor_id in the message.

◆ a_ipc_init_power_reboot_pending_publish_ind()

A_IPC_RESULT a_ipc_init_power_reboot_pending_publish_ind ( a_ipc_msg msg)

Initialize the message buffer to contain a_ipc_msg_power_reboot_pending_publish_ind.

msg->info.type will be A_IPC_MSG_POWER_REBOOT_PENDING_PUBLISH_IND.

This function can be called on an already initialized message to change its type.

Parameters
msgThe message buffer to initialize

◆ a_ipc_init_power_reboot_pending_subscribe_req()

A_IPC_RESULT a_ipc_init_power_reboot_pending_subscribe_req ( a_ipc_msg msg)

Initialize the message buffer to contain a_ipc_msg_power_reboot_pending_subscribe_req.

msg->info.type will be A_IPC_MSG_POWER_REBOOT_PENDING_SUBSCRIBE_REQ.

This function can be called on an already initialized message to change its type.

Parameters
msgThe message buffer to initialize

◆ a_ipc_init_power_reboot_pending_subscribe_rsp()

A_IPC_RESULT a_ipc_init_power_reboot_pending_subscribe_rsp ( a_ipc_msg msg)

Initialize the message buffer to contain a_ipc_msg_power_reboot_pending_subscribe_rsp.

msg->info.type will be A_IPC_MSG_POWER_REBOOT_PENDING_SUBSCRIBE_RSP.

This function can be called on an already initialized message to change its type.

Parameters
msgThe message buffer to initialize

◆ a_ipc_init_power_reboot_pending_unsubscribe_req_norsp()

A_IPC_RESULT a_ipc_init_power_reboot_pending_unsubscribe_req_norsp ( a_ipc_msg msg)

Initialize the message buffer to contain a_ipc_msg_power_reboot_pending_unsubscribe_req_norsp.

msg->info.type will be A_IPC_MSG_POWER_REBOOT_PENDING_UNSUBSCRIBE_REQ_NORSP.

This function can be called on an already initialized message to change its type.

Parameters
msgThe message buffer to initialize

◆ a_ipc_init_power_release_req_norsp()

A_IPC_RESULT a_ipc_init_power_release_req_norsp ( a_ipc_msg msg,
uint32_t  user_maxlength 
)

Initialize the message buffer to contain a_ipc_msg_power_release_req_norsp.

msg->info.type will be A_IPC_MSG_POWER_RELEASE_REQ_NORSP.

This function can be called on an already initialized message to change its type.

Parameters
msgThe message buffer to initialize
user_maxlengthThe maximum string length for user in the message.

◆ a_ipc_init_power_request_req()

A_IPC_RESULT a_ipc_init_power_request_req ( a_ipc_msg msg,
uint32_t  user_maxlength 
)

Initialize the message buffer to contain a_ipc_msg_power_request_req.

msg->info.type will be A_IPC_MSG_POWER_REQUEST_REQ.

This function can be called on an already initialized message to change its type.

Parameters
msgThe message buffer to initialize
user_maxlengthThe maximum string length for user in the message.

◆ a_ipc_init_power_request_rsp()

A_IPC_RESULT a_ipc_init_power_request_rsp ( a_ipc_msg msg)

Initialize the message buffer to contain a_ipc_msg_power_request_rsp.

msg->info.type will be A_IPC_MSG_POWER_REQUEST_RSP.

This function can be called on an already initialized message to change its type.

Parameters
msgThe message buffer to initialize

◆ a_ipc_init_power_shutdown_ack_req_norsp()

A_IPC_RESULT a_ipc_init_power_shutdown_ack_req_norsp ( a_ipc_msg msg,
uint32_t  user_maxlength 
)

Initialize the message buffer to contain a_ipc_msg_power_shutdown_ack_req_norsp.

msg->info.type will be A_IPC_MSG_POWER_SHUTDOWN_ACK_REQ_NORSP.

This function can be called on an already initialized message to change its type.

Parameters
msgThe message buffer to initialize
user_maxlengthThe maximum string length for user in the message.

◆ a_ipc_init_power_shutdown_publish_ind()

A_IPC_RESULT a_ipc_init_power_shutdown_publish_ind ( a_ipc_msg msg)

Initialize the message buffer to contain a_ipc_msg_power_shutdown_publish_ind.

msg->info.type will be A_IPC_MSG_POWER_SHUTDOWN_PUBLISH_IND.

This function can be called on an already initialized message to change its type.

Parameters
msgThe message buffer to initialize

◆ a_ipc_init_power_shutdown_reboot_req_norsp()

A_IPC_RESULT a_ipc_init_power_shutdown_reboot_req_norsp ( a_ipc_msg msg)

Initialize the message buffer to contain a_ipc_msg_power_shutdown_reboot_req_norsp.

msg->info.type will be A_IPC_MSG_POWER_SHUTDOWN_REBOOT_REQ_NORSP.

This function can be called on an already initialized message to change its type.

Parameters
msgThe message buffer to initialize

◆ a_ipc_init_power_shutdown_register_req()

A_IPC_RESULT a_ipc_init_power_shutdown_register_req ( a_ipc_msg msg,
uint32_t  user_maxlength 
)

Initialize the message buffer to contain a_ipc_msg_power_shutdown_register_req.

msg->info.type will be A_IPC_MSG_POWER_SHUTDOWN_REGISTER_REQ.

This function can be called on an already initialized message to change its type.

Parameters
msgThe message buffer to initialize
user_maxlengthThe maximum string length for user in the message.

◆ a_ipc_init_power_shutdown_register_rsp()

A_IPC_RESULT a_ipc_init_power_shutdown_register_rsp ( a_ipc_msg msg)

Initialize the message buffer to contain a_ipc_msg_power_shutdown_register_rsp.

msg->info.type will be A_IPC_MSG_POWER_SHUTDOWN_REGISTER_RSP.

This function can be called on an already initialized message to change its type.

Parameters
msgThe message buffer to initialize

◆ a_ipc_init_power_shutdown_shutdown_req_norsp()

A_IPC_RESULT a_ipc_init_power_shutdown_shutdown_req_norsp ( a_ipc_msg msg)

Initialize the message buffer to contain a_ipc_msg_power_shutdown_shutdown_req_norsp.

msg->info.type will be A_IPC_MSG_POWER_SHUTDOWN_SHUTDOWN_REQ_NORSP.

This function can be called on an already initialized message to change its type.

Parameters
msgThe message buffer to initialize

◆ a_ipc_init_power_shutdown_subscribe_req()

A_IPC_RESULT a_ipc_init_power_shutdown_subscribe_req ( a_ipc_msg msg)

Initialize the message buffer to contain a_ipc_msg_power_shutdown_subscribe_req.

msg->info.type will be A_IPC_MSG_POWER_SHUTDOWN_SUBSCRIBE_REQ.

This function can be called on an already initialized message to change its type.

Parameters
msgThe message buffer to initialize

◆ a_ipc_init_power_shutdown_subscribe_rsp()

A_IPC_RESULT a_ipc_init_power_shutdown_subscribe_rsp ( a_ipc_msg msg)

Initialize the message buffer to contain a_ipc_msg_power_shutdown_subscribe_rsp.

msg->info.type will be A_IPC_MSG_POWER_SHUTDOWN_SUBSCRIBE_RSP.

This function can be called on an already initialized message to change its type.

Parameters
msgThe message buffer to initialize

◆ a_ipc_init_power_shutdown_unregister_req_norsp()

A_IPC_RESULT a_ipc_init_power_shutdown_unregister_req_norsp ( a_ipc_msg msg,
uint32_t  user_maxlength 
)

Initialize the message buffer to contain a_ipc_msg_power_shutdown_unregister_req_norsp.

msg->info.type will be A_IPC_MSG_POWER_SHUTDOWN_UNREGISTER_REQ_NORSP.

This function can be called on an already initialized message to change its type.

Parameters
msgThe message buffer to initialize
user_maxlengthThe maximum string length for user in the message.

◆ a_ipc_init_power_shutdown_unsubscribe_req_norsp()

A_IPC_RESULT a_ipc_init_power_shutdown_unsubscribe_req_norsp ( a_ipc_msg msg)

Initialize the message buffer to contain a_ipc_msg_power_shutdown_unsubscribe_req_norsp.

msg->info.type will be A_IPC_MSG_POWER_SHUTDOWN_UNSUBSCRIBE_REQ_NORSP.

This function can be called on an already initialized message to change its type.

Parameters
msgThe message buffer to initialize

◆ a_ipc_init_power_suspend_ack_req_norsp()

A_IPC_RESULT a_ipc_init_power_suspend_ack_req_norsp ( a_ipc_msg msg,
uint32_t  user_maxlength 
)

Initialize the message buffer to contain a_ipc_msg_power_suspend_ack_req_norsp.

msg->info.type will be A_IPC_MSG_POWER_SUSPEND_ACK_REQ_NORSP.

This function can be called on an already initialized message to change its type.

Parameters
msgThe message buffer to initialize
user_maxlengthThe maximum string length for user in the message.

◆ a_ipc_init_power_suspend_publish_ind()

A_IPC_RESULT a_ipc_init_power_suspend_publish_ind ( a_ipc_msg msg)

Initialize the message buffer to contain a_ipc_msg_power_suspend_publish_ind.

msg->info.type will be A_IPC_MSG_POWER_SUSPEND_PUBLISH_IND.

This function can be called on an already initialized message to change its type.

Parameters
msgThe message buffer to initialize

◆ a_ipc_init_power_suspend_register_req()

A_IPC_RESULT a_ipc_init_power_suspend_register_req ( a_ipc_msg msg,
uint32_t  user_maxlength 
)

Initialize the message buffer to contain a_ipc_msg_power_suspend_register_req.

msg->info.type will be A_IPC_MSG_POWER_SUSPEND_REGISTER_REQ.

This function can be called on an already initialized message to change its type.

Parameters
msgThe message buffer to initialize
user_maxlengthThe maximum string length for user in the message.

◆ a_ipc_init_power_suspend_register_rsp()

A_IPC_RESULT a_ipc_init_power_suspend_register_rsp ( a_ipc_msg msg)

Initialize the message buffer to contain a_ipc_msg_power_suspend_register_rsp.

msg->info.type will be A_IPC_MSG_POWER_SUSPEND_REGISTER_RSP.

This function can be called on an already initialized message to change its type.

Parameters
msgThe message buffer to initialize

◆ a_ipc_init_power_suspend_subscribe_req()

A_IPC_RESULT a_ipc_init_power_suspend_subscribe_req ( a_ipc_msg msg)

Initialize the message buffer to contain a_ipc_msg_power_suspend_subscribe_req.

msg->info.type will be A_IPC_MSG_POWER_SUSPEND_SUBSCRIBE_REQ.

This function can be called on an already initialized message to change its type.

Parameters
msgThe message buffer to initialize

◆ a_ipc_init_power_suspend_subscribe_rsp()

A_IPC_RESULT a_ipc_init_power_suspend_subscribe_rsp ( a_ipc_msg msg)

Initialize the message buffer to contain a_ipc_msg_power_suspend_subscribe_rsp.

msg->info.type will be A_IPC_MSG_POWER_SUSPEND_SUBSCRIBE_RSP.

This function can be called on an already initialized message to change its type.

Parameters
msgThe message buffer to initialize

◆ a_ipc_init_power_suspend_unregister_req_norsp()

A_IPC_RESULT a_ipc_init_power_suspend_unregister_req_norsp ( a_ipc_msg msg,
uint32_t  user_maxlength 
)

Initialize the message buffer to contain a_ipc_msg_power_suspend_unregister_req_norsp.

msg->info.type will be A_IPC_MSG_POWER_SUSPEND_UNREGISTER_REQ_NORSP.

This function can be called on an already initialized message to change its type.

Parameters
msgThe message buffer to initialize
user_maxlengthThe maximum string length for user in the message.

◆ a_ipc_init_power_suspend_unsubscribe_req_norsp()

A_IPC_RESULT a_ipc_init_power_suspend_unsubscribe_req_norsp ( a_ipc_msg msg)

Initialize the message buffer to contain a_ipc_msg_power_suspend_unsubscribe_req_norsp.

msg->info.type will be A_IPC_MSG_POWER_SUSPEND_UNSUBSCRIBE_REQ_NORSP.

This function can be called on an already initialized message to change its type.

Parameters
msgThe message buffer to initialize

◆ a_ipc_init_power_wakeup_publish_ind()

A_IPC_RESULT a_ipc_init_power_wakeup_publish_ind ( a_ipc_msg msg)

Initialize the message buffer to contain a_ipc_msg_power_wakeup_publish_ind.

msg->info.type will be A_IPC_MSG_POWER_WAKEUP_PUBLISH_IND.

This function can be called on an already initialized message to change its type.

Parameters
msgThe message buffer to initialize

◆ a_ipc_init_power_wakeup_subscribe_req()

A_IPC_RESULT a_ipc_init_power_wakeup_subscribe_req ( a_ipc_msg msg)

Initialize the message buffer to contain a_ipc_msg_power_wakeup_subscribe_req.

msg->info.type will be A_IPC_MSG_POWER_WAKEUP_SUBSCRIBE_REQ.

This function can be called on an already initialized message to change its type.

Parameters
msgThe message buffer to initialize

◆ a_ipc_init_power_wakeup_subscribe_rsp()

A_IPC_RESULT a_ipc_init_power_wakeup_subscribe_rsp ( a_ipc_msg msg)

Initialize the message buffer to contain a_ipc_msg_power_wakeup_subscribe_rsp.

msg->info.type will be A_IPC_MSG_POWER_WAKEUP_SUBSCRIBE_RSP.

This function can be called on an already initialized message to change its type.

Parameters
msgThe message buffer to initialize

◆ a_ipc_init_power_wakeup_unsubscribe_req_norsp()

A_IPC_RESULT a_ipc_init_power_wakeup_unsubscribe_req_norsp ( a_ipc_msg msg)

Initialize the message buffer to contain a_ipc_msg_power_wakeup_unsubscribe_req_norsp.

msg->info.type will be A_IPC_MSG_POWER_WAKEUP_UNSUBSCRIBE_REQ_NORSP.

This function can be called on an already initialized message to change its type.

Parameters
msgThe message buffer to initialize

Variable Documentation

◆ delay_s

uint32_t a_ipc_msg_power_shutdown_reboot_req_norsp::delay_s

Wait 'delay_s' seconds before rebooting.

◆ no_of_clients

uint32_t a_ipc_msg_power_get_no_of_requestors_rsp::no_of_clients

Number of 'clients' requesting the system to be powered on.

◆ requestor_id

a_ipc_dyn_string a_ipc_msg_power_get_requestor_info_rsp::requestor_id

Id of the requestor.

◆ requestor_index

uint32_t a_ipc_msg_power_get_requestor_info_req::requestor_index

Index of the requestor we are interested in.

◆ result [1/9]

a_ipc_enum_power_result a_ipc_msg_power_request_rsp::result

Result of the operation.

◆ result [2/9]

a_ipc_enum_power_result a_ipc_msg_power_suspend_register_rsp::result

Result of the operation.

◆ result [3/9]

a_ipc_enum_power_result a_ipc_msg_power_shutdown_register_rsp::result

Result of the operation.

◆ result [4/9]

a_ipc_enum_power_result a_ipc_msg_power_get_no_of_requestors_rsp::result

Result of the operation.

◆ result [5/9]

a_ipc_enum_power_result a_ipc_msg_power_get_requestor_info_rsp::result

Result of the operation.

◆ result [6/9]

a_ipc_enum_ipc_subscribe_result a_ipc_msg_power_suspend_subscribe_rsp::result

The result of the subscription request.

◆ result [7/9]

a_ipc_enum_ipc_subscribe_result a_ipc_msg_power_shutdown_subscribe_rsp::result

The result of the subscription request.

◆ result [8/9]

a_ipc_enum_ipc_subscribe_result a_ipc_msg_power_reboot_pending_subscribe_rsp::result

The result of the subscription request.

◆ result [9/9]

a_ipc_enum_ipc_subscribe_result a_ipc_msg_power_wakeup_subscribe_rsp::result

The result of the subscription request.

◆ user [1/8]

a_ipc_dyn_string a_ipc_msg_power_request_req::user

User identifier, max 15 characters long.

◆ user [2/8]

a_ipc_dyn_string a_ipc_msg_power_release_req_norsp::user

User identifier, max 15 characters long.

◆ user [3/8]

a_ipc_dyn_string a_ipc_msg_power_suspend_register_req::user

User identifier, max 15 characters long.

◆ user [4/8]

a_ipc_dyn_string a_ipc_msg_power_suspend_unregister_req_norsp::user

User identifier, max 15 characters long.

◆ user [5/8]

a_ipc_dyn_string a_ipc_msg_power_suspend_ack_req_norsp::user

User identifier, max 15 characters long.

◆ user [6/8]

a_ipc_dyn_string a_ipc_msg_power_shutdown_register_req::user

User identifier, max 15 characters long.

◆ user [7/8]

a_ipc_dyn_string a_ipc_msg_power_shutdown_unregister_req_norsp::user

User identifier, max 15 characters long.

◆ user [8/8]

a_ipc_dyn_string a_ipc_msg_power_shutdown_ack_req_norsp::user

User identifier, max 15 characters long.