TI BLE-Stack for Bluetooth 4.2 API Documentation  3.01.00.07
Macros
ICall Constants

Macros

#define ICALL_CUSTOM_INIT_PARAMS   { USER0_CFG }
 
#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 inbetween application and services. More...
 
#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
 
#define ICALL_MSG_FUNC_GET_LOCAL_MSG_ENTITY_ID   0
 Messaging service function id for translating ICall_entityID to locally understandable id.
 
#define ICALL_PWR_AWAKE_FROM_STANDBY   0
 
#define ICALL_PWR_AWAKE_FROM_STANDBY_LATE   5
 
#define ICALL_PWR_C_IDLE_PD_DISALLOW   0x00000008l
 
#define ICALL_PWR_C_NEED_FLASH_IN_IDLE   0x00000010l
 
#define ICALL_PWR_C_SB_DISALLOW   0x00000004l
 
#define ICALL_PWR_C_SB_VIMS_CACHE_RETAIN   0x00000001l
 
#define ICALL_PWR_C_SD_DISALLOW   0x00000002l
 
#define ICALL_PWR_D_DOMAIN_PERIPH   0x00100000l
 
#define ICALL_PWR_D_DOMAIN_RFCORE   0x00400000l
 
#define ICALL_PWR_D_DOMAIN_SERIAL   0x00200000l
 
#define ICALL_PWR_D_DOMAIN_SYSBUS   0x00800000l
 
#define ICALL_PWR_D_PERIPH_CRYPTO   0x00010000l
 
#define ICALL_PWR_D_PERIPH_GPIO   0x00004000l
 
#define ICALL_PWR_D_PERIPH_GPT0   0x00000020l
 
#define ICALL_PWR_D_PERIPH_GPT1   0x00000040l
 
#define ICALL_PWR_D_PERIPH_GPT2   0x00000080l
 
#define ICALL_PWR_D_PERIPH_GPT3   0x00000100l
 
#define ICALL_PWR_D_PERIPH_I2C0   0x00001000l
 
#define ICALL_PWR_D_PERIPH_I2S   0x00020000l
 
#define ICALL_PWR_D_PERIPH_RFCORE   0x00040000l
 
#define ICALL_PWR_D_PERIPH_SSI0   0x00000200l
 
#define ICALL_PWR_D_PERIPH_SSI1   0x00000400l
 
#define ICALL_PWR_D_PERIPH_TRNG   0x00002000l
 
#define ICALL_PWR_D_PERIPH_UART0   0x00000800l
 
#define ICALL_PWR_D_PERIPH_UDMA   0x00008000l
 
#define ICALL_PWR_D_XOSC_HF   0x00080000l
 
#define ICALL_PWR_ENTER_SHUTDOWN   4
 
#define ICALL_PWR_ENTER_STANDBY   2
 
#define ICALL_PWR_TRANSITION_ENTERING_SLEEP   2
 
#define ICALL_PWR_TRANSITION_EXITING_SLEEP   3
 
#define ICALL_PWR_TRANSITION_STAY_IN_ACTIVE   1
 
#define ICALL_PWR_TRANSITION_UNKNOWN   0
 
#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. More...
 
#define ICALL_SERVICE_CLASS_BLE_MSG   0x0050
 BLE stack message delivery service.
 
#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.
 
#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.
 
#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. More...
 
#define ICALL_SERVICE_CLASS_ZSTACK   0x0030
 ZStack service class enumerated value.
 
#define ICALL_SERVICE_INSTANCE_MASK   0x0007
 Bit mask for recommended service id enumeration. More...
 
#define ICALL_STACK0_ADDR   0x00005000ul
 
#define ICALL_TASK_PRIORITIES   { 5 }
 
#define ICALL_TASK_STACK_SIZES   { 1000 }
 
#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 exeuction. More...
 
#define USER0_CFG   &user0Cfg
 user config
 

Detailed Description

Macro Definition Documentation

§ ICALL_CUSTOM_INIT_PARAMS

#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.

§ ICALL_MSG_EVENT_ID

#define ICALL_MSG_EVENT_ID   Event_Id_31

Event reserved to signal for icall message inbetween application and services.

Used when ICALL_EVENTS compile option is enabled only.

§ ICALL_MSG_FORMAT_KEEP

#define ICALL_MSG_FORMAT_KEEP   0

Message format that requires no change

§ ICALL_PWR_AWAKE_FROM_STANDBY

#define ICALL_PWR_AWAKE_FROM_STANDBY   0

Power state transition to active power state from standby power state.

§ ICALL_PWR_AWAKE_FROM_STANDBY_LATE

#define ICALL_PWR_AWAKE_FROM_STANDBY_LATE   5

Power state transition to active power state where IOs can be accessed, from standby power state.

§ ICALL_PWR_C_IDLE_PD_DISALLOW

#define ICALL_PWR_C_IDLE_PD_DISALLOW   0x00000008l

A power API constraint flag that can be added to a bitmap used as the argument to ICall_pwrConfigACAction(), ICall_pwrRequire() and ICall_pwrDispense().

§ ICALL_PWR_C_NEED_FLASH_IN_IDLE

#define ICALL_PWR_C_NEED_FLASH_IN_IDLE   0x00000010l

A power API constraint flag that can be added to a bitmap used as the argument to ICall_pwrConfigACAction(), ICall_pwrRequire() and ICall_pwrDispense().

§ ICALL_PWR_C_SB_DISALLOW

#define ICALL_PWR_C_SB_DISALLOW   0x00000004l

A power API constraint flag that can be added to a bitmap used as the argument to ICall_pwrConfigACAction(), ICall_pwrRequire() and ICall_pwrDispense().

§ ICALL_PWR_C_SB_VIMS_CACHE_RETAIN

#define ICALL_PWR_C_SB_VIMS_CACHE_RETAIN   0x00000001l

A power API constraint flag that can be added to a bitmap used as the argument to ICall_pwrConfigACAction(), ICall_pwrRequire() and ICall_pwrDispense().

§ ICALL_PWR_C_SD_DISALLOW

#define ICALL_PWR_C_SD_DISALLOW   0x00000002l

A power API constraint flag that can be added to a bitmap used as the argument to ICall_pwrConfigACAction(), ICall_pwrRequire() and ICall_pwrDispense().

§ ICALL_PWR_D_DOMAIN_PERIPH

#define ICALL_PWR_D_DOMAIN_PERIPH   0x00100000l

A power API dependency flag that can be added to a bitmap used as the argument to ICall_pwrConfigACAction(), ICall_pwrRequire() and ICall_pwrDispense().

§ ICALL_PWR_D_DOMAIN_RFCORE

#define ICALL_PWR_D_DOMAIN_RFCORE   0x00400000l

A power API dependency flag that can be added to a bitmap used as the argument to ICall_pwrConfigACAction(), ICall_pwrRequire() and ICall_pwrDispense().

§ ICALL_PWR_D_DOMAIN_SERIAL

#define ICALL_PWR_D_DOMAIN_SERIAL   0x00200000l

A power API dependency flag that can be added to a bitmap used as the argument to ICall_pwrConfigACAction(), ICall_pwrRequire() and ICall_pwrDispense().

§ ICALL_PWR_D_DOMAIN_SYSBUS

#define ICALL_PWR_D_DOMAIN_SYSBUS   0x00800000l

A power API dependency flag that can be added to a bitmap used as the argument to ICall_pwrConfigACAction(), ICall_pwrRequire() and ICall_pwrDispense().

§ ICALL_PWR_D_PERIPH_CRYPTO

#define ICALL_PWR_D_PERIPH_CRYPTO   0x00010000l

A power API dependency flag that can be added to a bitmap used as the argument to ICall_pwrConfigACAction(), ICall_pwrRequire() and ICall_pwrDispense().

§ ICALL_PWR_D_PERIPH_GPIO

#define ICALL_PWR_D_PERIPH_GPIO   0x00004000l

A power API dependency flag that can be added to a bitmap used as the argument to ICall_pwrConfigACAction(), ICall_pwrRequire() and ICall_pwrDispense().

§ ICALL_PWR_D_PERIPH_GPT0

#define ICALL_PWR_D_PERIPH_GPT0   0x00000020l

A power API dependency flag that can be added to a bitmap used as the argument to ICall_pwrConfigACAction(), ICall_pwrRequire() and ICall_pwrDispense().

§ ICALL_PWR_D_PERIPH_GPT1

#define ICALL_PWR_D_PERIPH_GPT1   0x00000040l

A power API dependency flag that can be added to a bitmap used as the argument to ICall_pwrConfigACAction(), ICall_pwrRequire() and ICall_pwrDispense().

§ ICALL_PWR_D_PERIPH_GPT2

#define ICALL_PWR_D_PERIPH_GPT2   0x00000080l

A power API dependency flag that can be added to a bitmap used as the argument to ICall_pwrConfigACAction(), ICall_pwrRequire() and ICall_pwrDispense().

§ ICALL_PWR_D_PERIPH_GPT3

#define ICALL_PWR_D_PERIPH_GPT3   0x00000100l

A power API dependency flag that can be added to a bitmap used as the argument to ICall_pwrConfigACAction(), ICall_pwrRequire() and ICall_pwrDispense().

§ ICALL_PWR_D_PERIPH_I2C0

#define ICALL_PWR_D_PERIPH_I2C0   0x00001000l

A power API dependency flag that can be added to a bitmap used as the argument to ICall_pwrConfigACAction(), ICall_pwrRequire() and ICall_pwrDispense().

§ ICALL_PWR_D_PERIPH_I2S

#define ICALL_PWR_D_PERIPH_I2S   0x00020000l

A power API dependency flag that can be added to a bitmap used as the argument to ICall_pwrConfigACAction(), ICall_pwrRequire() and ICall_pwrDispense().

§ ICALL_PWR_D_PERIPH_RFCORE

#define ICALL_PWR_D_PERIPH_RFCORE   0x00040000l

A power API dependency flag that can be added to a bitmap used as the argument to ICall_pwrConfigACAction(), ICall_pwrRequire() and ICall_pwrDispense().

§ ICALL_PWR_D_PERIPH_SSI0

#define ICALL_PWR_D_PERIPH_SSI0   0x00000200l

A power API dependency flag that can be added to a bitmap used as the argument to ICall_pwrConfigACAction(), ICall_pwrRequire() and ICall_pwrDispense().

§ ICALL_PWR_D_PERIPH_SSI1

#define ICALL_PWR_D_PERIPH_SSI1   0x00000400l

A power API dependency flag that can be added to a bitmap used as the argument to ICall_pwrConfigACAction(), ICall_pwrRequire() and ICall_pwrDispense().

§ ICALL_PWR_D_PERIPH_TRNG

#define ICALL_PWR_D_PERIPH_TRNG   0x00002000l

A power API dependency flag that can be added to a bitmap used as the argument to ICall_pwrConfigACAction(), ICall_pwrRequire() and ICall_pwrDispense().

§ ICALL_PWR_D_PERIPH_UART0

#define ICALL_PWR_D_PERIPH_UART0   0x00000800l

A power API dependency flag that can be added to a bitmap used as the argument to ICall_pwrConfigACAction(), ICall_pwrRequire() and ICall_pwrDispense().

§ ICALL_PWR_D_PERIPH_UDMA

#define ICALL_PWR_D_PERIPH_UDMA   0x00008000l

A power API dependency flag that can be added to a bitmap used as the argument to ICall_pwrConfigACAction(), ICall_pwrRequire() and ICall_pwrDispense().

§ ICALL_PWR_D_XOSC_HF

#define ICALL_PWR_D_XOSC_HF   0x00080000l

A power API dependency flag that can be added to a bitmap used as the argument to ICall_pwrConfigACAction(), ICall_pwrRequire() and ICall_pwrDispense().

§ ICALL_PWR_ENTER_SHUTDOWN

#define ICALL_PWR_ENTER_SHUTDOWN   4

Power state transition to shut down power state from active power state

§ ICALL_PWR_ENTER_STANDBY

#define ICALL_PWR_ENTER_STANDBY   2

Power state transition to standby power state from active power state.

§ ICALL_PWR_TRANSITION_ENTERING_SLEEP

#define ICALL_PWR_TRANSITION_ENTERING_SLEEP   2

Return value of ICall_pwrGetTransitionState(). Transitioning into sleep.

§ ICALL_PWR_TRANSITION_EXITING_SLEEP

#define ICALL_PWR_TRANSITION_EXITING_SLEEP   3

Return value of ICall_pwrGetTransitionState(). Transitioning out of sleep.

§ ICALL_PWR_TRANSITION_STAY_IN_ACTIVE

#define ICALL_PWR_TRANSITION_STAY_IN_ACTIVE   1

Return value of ICall_pwrGetTransitionState(). Power state transition not happening.

§ ICALL_PWR_TRANSITION_UNKNOWN

#define ICALL_PWR_TRANSITION_UNKNOWN   0

Return value of ICall_pwrGetTransitionState(). Power state transition cannot be retrieved.

§ ICALL_SERVICE_CLASS_BLE_BOARD

#define ICALL_SERVICE_CLASS_BLE_BOARD   0x0088

BLE Board dependent service class.

This service is intended for BLE stack software's use only.

§ ICALL_SERVICE_CLASS_CRYPTO

#define ICALL_SERVICE_CLASS_CRYPTO   0x0080

Crypto service class.

Crypto service is intended for stack software to use.

§ ICALL_SERVICE_CLASS_DUMMY

#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.

§ ICALL_SERVICE_CLASS_DUMMY_BOARD

#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.

§ ICALL_SERVICE_CLASS_MASK

#define ICALL_SERVICE_CLASS_MASK   0xFFF8

Bit mask for recommended service id enumeration.

These bits can be used to identify a service class.

§ ICALL_SERVICE_CLASS_PRIMITIVE

#define ICALL_SERVICE_CLASS_PRIMITIVE   0x0008

Service class enumerated value for primitive service.

Primitive service includes heap service and messaging service.

§ ICALL_SERVICE_CLASS_RADIO

#define ICALL_SERVICE_CLASS_RADIO   0x0098

Radio service class.

Radio service is intended for stack software to use.

§ ICALL_SERVICE_CLASS_TIMAC_BOARD

#define ICALL_SERVICE_CLASS_TIMAC_BOARD   0x0090

TIMAC Board dependent service class.

This service is intended for TIMAC stack software's use only.

§ ICALL_SERVICE_INSTANCE_MASK

#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.

§ ICALL_STACK0_ADDR

#define ICALL_STACK0_ADDR   0x00005000ul

An entry function address of an external image. Note that it is not necessary to define this macro in this header file. The macro is internally used to expand ICALL_ADDR_MAPS and also used for the sample DummyStack code.

§ ICALL_TASK_PRIORITIES

#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.

§ ICALL_TASK_STACK_SIZES

#define ICALL_TASK_STACK_SIZES   { 1000 }

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.

§ ICALL_WAITMATCH_EVENT_ID

#define ICALL_WAITMATCH_EVENT_ID   Event_Id_29

Event reserved to signal a wait match period has ended and the caller may continue exeuction.

Note
The Event_Id_30 is usually reserved for the the application internal queue processing.
Copyright 2017, Texas Instruments Incorporated