ipc_led

LED Service. More...

Data Structures
struct	a_ipc_dyn_array_enum_led_result
	Dynamic-length array of a_ipc_enum_led_result. More...
struct	a_ipc_dyn_array_enum_led_pin_type
	Dynamic-length array of a_ipc_enum_led_pin_type. More...
struct	a_ipc_msg_led_set_req
	Message used to request a pin to be enabled or disabled. More...
struct	a_ipc_msg_led_set_rsp
	Led configure result. More...

Enumerations
enum	a_ipc_enum_led_result { A_IPC_ENUM_LED_RESULT_OK , A_IPC_ENUM_LED_RESULT_ERROR_INVALID_PARAMETER , A_IPC_ENUM_LED_RESULT_ERROR_UNKNOWN }
	Result codes. More...
enum	a_ipc_enum_led_pin_type { A_IPC_ENUM_LED_PIN_TYPE_GREEN , A_IPC_ENUM_LED_PIN_TYPE_RED , A_IPC_ENUM_LED_PIN_TYPE_BLUE , A_IPC_ENUM_LED_PIN_TYPE_NUMBER_OF_LEDS }
	LED pin type. More...

Functions
A_IPC_RESULT	a_ipc_init_led_set_req (a_ipc_msg *msg)
	Initialize the message buffer to contain a_ipc_msg_led_set_req. More...
A_IPC_RESULT	a_ipc_init_led_set_rsp (a_ipc_msg *msg)
	Initialize the message buffer to contain a_ipc_msg_led_set_rsp. More...

Detailed Description

LED Service.

This page contains documentation of the System Service API.

---

Data Structure Documentation

a_ipc_dyn_array_enum_led_result

struct a_ipc_dyn_array_enum_led_result

Dynamic-length array of a_ipc_enum_led_result.

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

a_ipc_dyn_array_enum_led_pin_type

struct a_ipc_dyn_array_enum_led_pin_type

Dynamic-length array of a_ipc_enum_led_pin_type.

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

a_ipc_msg_led_set_req

struct a_ipc_msg_led_set_req

Message used to request a pin to be enabled or disabled.

Response is delivered in a_ipc_msg_led_set_rsp.

Create using a_ipc_init_led_set_req().

Message type is A_IPC_MSG_LED_SET_REQ.

Data Fields
a_ipc_enum_led_pin_type	pin	Type of pin to set.
uint8_t	value	0: Disable, 1: Enable

a_ipc_msg_led_set_rsp

struct a_ipc_msg_led_set_rsp

Led configure result.

Sent in response to a_ipc_msg_led_set_req.

Create using a_ipc_init_led_set_rsp().

Message type is A_IPC_MSG_LED_SET_RSP.

Data Fields
a_ipc_enum_led_result	result	Result of the operation.

Enumeration Type Documentation

a_ipc_enum_led_pin_type

enum a_ipc_enum_led_pin_type

LED pin type.

Enumerator
A_IPC_ENUM_LED_PIN_TYPE_GREEN	Green.
A_IPC_ENUM_LED_PIN_TYPE_RED	Red.
A_IPC_ENUM_LED_PIN_TYPE_BLUE	Blue.

a_ipc_enum_led_result

enum a_ipc_enum_led_result

Result codes.

Enumerator
A_IPC_ENUM_LED_RESULT_OK	OK.
A_IPC_ENUM_LED_RESULT_ERROR_INVALID_PARAMETER	Invalid parameter.
A_IPC_ENUM_LED_RESULT_ERROR_UNKNOWN	Unknown.

Function Documentation

a_ipc_init_led_set_req()

A_IPC_RESULT a_ipc_init_led_set_req

(

a_ipc_msg *

msg

)

Initialize the message buffer to contain a_ipc_msg_led_set_req.

msg->info.type will be A_IPC_MSG_LED_SET_REQ.

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

Parameters

msg	The message buffer to initialize

a_ipc_init_led_set_rsp()

A_IPC_RESULT a_ipc_init_led_set_rsp

(

a_ipc_msg *

msg

)

Initialize the message buffer to contain a_ipc_msg_led_set_rsp.

msg->info.type will be A_IPC_MSG_LED_SET_RSP.

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

Parameters

msg	The message buffer to initialize

Variable Documentation

pin

a_ipc_enum_led_pin_type a_ipc_msg_led_set_req::pin

Type of pin to set.

result

a_ipc_enum_led_result a_ipc_msg_led_set_rsp::result

Result of the operation.

value

uint8_t a_ipc_msg_led_set_req::value

0: Disable, 1: Enable