|
|
|
TI BLE5-Stack API Documentation
9.11.01
|
Macros | |
| #define | ICALL_CUSTOM_INIT_PARAMS { USER0_CFG } |
| #define | ICALL_ERRNO_CORRUPT_MSG -6 |
| ICall function return value for corrupt message error. More... | |
| #define | ICALL_ERRNO_INVALID_FUNCTION -2 |
| ICall function return value in case the function id is unknown to the registered handler of the service. More... | |
| #define | ICALL_ERRNO_INVALID_PARAMETER -3 |
| ICall function return value for invalid parameter value. More... | |
| #define | ICALL_ERRNO_INVALID_SERVICE -1 |
| ICall function return value in case the service corresponding to a passed service id is not registered and hence is unknown. More... | |
| #define | ICALL_ERRNO_NO_RESOURCE -4 |
| ICall function return value for no resource error. More... | |
| #define | ICALL_ERRNO_NOMSG 2 |
| ICall function return value for no message error. More... | |
| #define | ICALL_ERRNO_OVERFLOW -7 |
| ICall function return value for counter overflow. More... | |
| #define | ICALL_ERRNO_SUCCESS 0 |
| ICall function return value for successful operation. More... | |
| #define | ICALL_ERRNO_TIMEOUT 1 |
| ICall function return value for timeout error. More... | |
| #define | ICALL_ERRNO_UNDERFLOW -8 |
| ICall function return value for counter underflow. More... | |
| #define | ICALL_ERRNO_UNKNOWN_THREAD -5 |
| ICall function return value in case the calling thread context is not a registered thread, or the entity id passed is not a registered entity. More... | |
| #define | ICALL_INVALID_ENTITY_ID 0xffu |
| Entity ID used to indicate invalid entity. More... | |
| #define | ICALL_INVALID_TIMER_ID NULL |
| Timer ID used to indicate invalid ID. More... | |
| #define | ICALL_LITE_DIRECT_API_DONE_CMD_ID 0x42 |
| Message CMD ID to signal DIRECT_API CMD is done. More... | |
| #define | ICALL_MSG_EVENT_ID Event_Id_31 |
| #define | ICALL_MSG_FORMAT_1ST_CHAR_TASK_ID 1 |
| Message format that requires the first byte to be replaced with the src task ID. More... | |
| #define | ICALL_MSG_FORMAT_3RD_CHAR_TASK_ID 2 |
| Message format that requires the third byte to be replaced with the src task ID. More... | |
| #define | ICALL_MSG_FORMAT_DIRECT_API_ID 3 |
| Message format indicated a direct API call. More... | |
| #define | ICALL_MSG_FORMAT_KEEP 0 |
| #define | ICALL_MSG_FUNC_GET_LOCAL_MSG_ENTITY_ID 0 |
| Messaging service function id for translating ICall_entityID to locally understandable id. More... | |
| #define | ICALL_SEMAPHORE_MODE_BINARY 1 |
| Binary semaphore mode. More... | |
| #define | ICALL_SEMAPHORE_MODE_COUNTING 0 |
| Counting semaphore mode. More... | |
| #define | ICALL_SERVICE_CLASS_BLE 0x0010 |
| BLE service class enumerated value. More... | |
| #define | ICALL_SERVICE_CLASS_BLE_BOARD 0x0088 |
| BLE Board dependent service class. More... | |
| #define | ICALL_SERVICE_CLASS_BLE_MSG 0x0050 |
| BLE stack message delivery service. More... | |
| #define | ICALL_SERVICE_CLASS_CRYPTO 0x0080 |
| Crypto service class. More... | |
| #define | ICALL_SERVICE_CLASS_DUMMY 0x0100 |
| #define | ICALL_SERVICE_CLASS_DUMMY_BOARD 0x0200 |
| Dummy stack board service class enumeration. More... | |
| #define | ICALL_SERVICE_CLASS_MASK 0xFFF8 |
| Bit mask for recommended service id enumeration. More... | |
| #define | ICALL_SERVICE_CLASS_NPI 0x0038 |
| NPI service class enumerated value. More... | |
| #define | ICALL_SERVICE_CLASS_PRIMITIVE 0x0008 |
| Service class enumerated value for primitive service. More... | |
| #define | ICALL_SERVICE_CLASS_RADIO 0x0098 |
| Radio service class. More... | |
| #define | ICALL_SERVICE_CLASS_REMOTI_RCN 0x0028 |
| RemoTI network layer service class enumerated value. More... | |
| #define | ICALL_SERVICE_CLASS_REMOTI_RTI 0x0020 |
| RemoTI RTI interface service class enumerated value. More... | |
| #define | ICALL_SERVICE_CLASS_TIMAC 0x0018 |
| TIMAC service class enumerated value. More... | |
| #define | ICALL_SERVICE_CLASS_TIMAC_BOARD 0x0090 |
| TIMAC Board dependent service class. More... | |
| #define | ICALL_SERVICE_CLASS_ZSTACK 0x0030 |
| ZStack service class enumerated value. More... | |
| #define | ICALL_SERVICE_INSTANCE_MASK 0x0007 |
| Bit mask for recommended service id enumeration. More... | |
| #define | ICALL_TASK_PRIORITIES { 5 } |
| #define | ICALL_TASK_STACK_SIZES { 1500 } |
| #define | ICALL_TIMEOUT_FOREVER 0xfffffffful |
| Time period that indicates infinite time. More... | |
| #define | ICALL_TIMEOUT_PREDEFINE 5000 |
| Time period that indicates timeout define at build time default is 5s. More... | |
| #define | ICALL_WAITMATCH_EVENT_ID Event_Id_29 |
| #define | USER0_CFG &user0Cfg |
| user config More... | |
| #define ICALL_CUSTOM_INIT_PARAMS { USER0_CFG } |
Initializer for custom initialization parameters. Each element of the array corresponds to initialization parameter (a pointer) specific to the image to be passed to the entry function defined in ICALL_ADDR_MAPS initializer.
| #define ICALL_ERRNO_CORRUPT_MSG -6 |
ICall function return value for corrupt message error.
| #define ICALL_ERRNO_INVALID_FUNCTION -2 |
ICall function return value in case the function id is unknown to the registered handler of the service.
| #define ICALL_ERRNO_INVALID_PARAMETER -3 |
ICall function return value for invalid parameter value.
| #define ICALL_ERRNO_INVALID_SERVICE -1 |
ICall function return value in case the service corresponding to a passed service id is not registered and hence is unknown.
| #define ICALL_ERRNO_NO_RESOURCE -4 |
ICall function return value for no resource error.
| #define ICALL_ERRNO_NOMSG 2 |
ICall function return value for no message error.
| #define ICALL_ERRNO_OVERFLOW -7 |
ICall function return value for counter overflow.
| #define ICALL_ERRNO_SUCCESS 0 |
ICall function return value for successful operation.
| #define ICALL_ERRNO_TIMEOUT 1 |
ICall function return value for timeout error.
| #define ICALL_ERRNO_UNDERFLOW -8 |
ICall function return value for counter underflow.
| #define ICALL_ERRNO_UNKNOWN_THREAD -5 |
ICall function return value in case the calling thread context is not a registered thread, or the entity id passed is not a registered entity.
| #define ICALL_INVALID_ENTITY_ID 0xffu |
Entity ID used to indicate invalid entity.
| #define ICALL_INVALID_TIMER_ID NULL |
Timer ID used to indicate invalid ID.
| #define ICALL_LITE_DIRECT_API_DONE_CMD_ID 0x42 |
Message CMD ID to signal DIRECT_API CMD is done.
| #define ICALL_MSG_EVENT_ID Event_Id_31 |
Event reserved to signal for icall message in between application and services.
Used when ICALL_EVENTS compile option is enabled only.
| #define ICALL_MSG_FORMAT_1ST_CHAR_TASK_ID 1 |
Message format that requires the first byte to be replaced with the src task ID.
| #define ICALL_MSG_FORMAT_3RD_CHAR_TASK_ID 2 |
Message format that requires the third byte to be replaced with the src task ID.
| #define ICALL_MSG_FORMAT_DIRECT_API_ID 3 |
Message format indicated a direct API call.
| #define ICALL_MSG_FORMAT_KEEP 0 |
Message format that requires no change
| #define ICALL_MSG_FUNC_GET_LOCAL_MSG_ENTITY_ID 0 |
Messaging service function id for translating ICall_entityID to locally understandable id.
| #define ICALL_SEMAPHORE_MODE_BINARY 1 |
Binary semaphore mode.
| #define ICALL_SEMAPHORE_MODE_COUNTING 0 |
Counting semaphore mode.
| #define ICALL_SERVICE_CLASS_BLE 0x0010 |
BLE service class enumerated value.
| #define ICALL_SERVICE_CLASS_BLE_BOARD 0x0088 |
BLE Board dependent service class.
This service is intended for BLE stack software's use only.
| #define ICALL_SERVICE_CLASS_BLE_MSG 0x0050 |
BLE stack message delivery service.
| #define ICALL_SERVICE_CLASS_CRYPTO 0x0080 |
Crypto service class.
Crypto service is intended for stack software to use.
| #define ICALL_SERVICE_CLASS_DUMMY 0x0100 |
Dummy stack service class enumeration. Dummy stack service is used as an example stack port on top of ICall module.
| #define ICALL_SERVICE_CLASS_DUMMY_BOARD 0x0200 |
Dummy stack board service class enumeration.
Dummy stack board service is used as an example board service for a stack.
| #define ICALL_SERVICE_CLASS_MASK 0xFFF8 |
Bit mask for recommended service id enumeration.
These bits can be used to identify a service class.
| #define ICALL_SERVICE_CLASS_NPI 0x0038 |
NPI service class enumerated value.
| #define ICALL_SERVICE_CLASS_PRIMITIVE 0x0008 |
Service class enumerated value for primitive service.
Primitive service includes heap service and messaging service.
| #define ICALL_SERVICE_CLASS_RADIO 0x0098 |
Radio service class.
Radio service is intended for stack software to use.
| #define ICALL_SERVICE_CLASS_REMOTI_RCN 0x0028 |
RemoTI network layer service class enumerated value.
| #define ICALL_SERVICE_CLASS_REMOTI_RTI 0x0020 |
RemoTI RTI interface service class enumerated value.
| #define ICALL_SERVICE_CLASS_TIMAC 0x0018 |
TIMAC service class enumerated value.
| #define ICALL_SERVICE_CLASS_TIMAC_BOARD 0x0090 |
TIMAC Board dependent service class.
This service is intended for TIMAC stack software's use only.
| #define ICALL_SERVICE_CLASS_ZSTACK 0x0030 |
ZStack service class enumerated value.
| #define ICALL_SERVICE_INSTANCE_MASK 0x0007 |
Bit mask for recommended service id enumeration.
These bits can be used to identify an instance among stack instances of the same service class.
| #define ICALL_TASK_PRIORITIES { 5 } |
Initializer for an array of thread priorities. Each element of the array corresponds to TI-RTOS specific thread priority value given to a thread to be created per the entry function defined in ICALL_ADDR_MAPS initializer, in the same sequence.
| #define ICALL_TASK_STACK_SIZES { 1500 } |
Initializer for an array of thread stack sizes. Each element of the array corresponds to stack depth allocated to a thread to be created per the entry function defined in ICALL_ADDR_MAPS initializer, in the same sequence.
| #define ICALL_TIMEOUT_FOREVER 0xfffffffful |
Time period that indicates infinite time.
| #define ICALL_TIMEOUT_PREDEFINE 5000 |
Time period that indicates timeout define at build time default is 5s.
| #define ICALL_WAITMATCH_EVENT_ID Event_Id_29 |
Event reserved to signal a wait match period has ended and the caller may continue execution.
| #define USER0_CFG &user0Cfg |
user config