Common

General Description

BLE Common macros.

Macros
#define	CY_BLE_LL_CONTROLLER_HEAP_REQ_SOC   (0u)
	The size of RAM memory required for the Stack controller.
#define	CY_BLE_GATT_DB_ATTR_BUFF_SIZE   (0u)
	The size of RAM memory required for store attribute handle state (Enable/Disable)
#define	CY_BLE_STACK_RAM_SIZE
	The size of RAM memory required for the Stack host. More...
#define	CY_BLE_STACK_CONTROLLER_RAM_SIZE   (CY_BLE_LL_CONTROLLER_HEAP_REQ)
	The size of RAM memory required for the Stack Controller.
#define	CY_BLE_STACK_FLASH_SIZE
	The size of flash memory required for the bonding data. More...
#define	CY_BLE_GAP_ADV_FLAG_LE_LIMITED_DISC_MODE   (0x01u)
	LE Limited Discoverable Mode. More...
#define	CY_BLE_GAP_ADV_FLAG_LE_GENERAL_DISC_MODE   (0x02u)
	LE General Discoverable Mode. More...
#define	CY_BLE_GAP_ADV_FLAG_BR_EDR_NOT_SUPPORTED   (0x04u)
	BR/EDR not supported. More...
#define	CY_BLE_GAP_ADV_FLAG_LE_BR_EDR_CONTROLLER   (0x08u)
	Simultaneous LE and BR/EDR, Controller. More...
#define	CY_BLE_GAP_ADV_FLAG_LE_BR_EDR_HOST   (0x10u)
	Simultaneous LE and BR/EDR, Host. More...
#define	CY_BLE_GAP_ADV_FLAGS_PACKET_LENGTH   (0x02u)
	Length of flags in an advertisement packet.
#define	CY_BLE_GAP_ADV_ADVERT_INTERVAL_MIN   (0x0020u)
	Minimum Advertising interval in 625 us units, i.e. More...
#define	CY_BLE_GAP_ADV_ADVERT_INTERVAL_NONCON_MIN   (0x00A0u)
	Minimum Advertising interval in 625 us units for non connectable mode, i.e. More...
#define	CY_BLE_GAP_ADV_ADVERT_INTERVAL_MAX   (0x4000u)
	Maximum Advertising interval in 625 us units, i.e. More...
#define	CY_BLE_GAP_ADV_ADVERT_INTERVAL_PACKET_LENGTH   (0x03u)
	Length of the Advertising Interval AD type in an advertisement packet.
#define	CY_BLE_GAPC_CONNECTING_TIMEOUT   (30u)
	Seconds.
#define	CY_BLE_INVALID_CONN_HANDLE_VALUE   (0xFFu)
	Invalid Connection Handle Value.
#define	CY_BLE_STORE_DATA_MODE_BLOCKING   (0x0u)
	Blocking write.
#define	CY_BLE_STORE_DATA_MODE_NON_BLOCKING   (0x1u)
	Non-blocking write.
#define	CY_BLE_CHAR_PROP_BROADCAST   (0x01u)
	Broadcast.
#define	CY_BLE_CHAR_PROP_READ   (0x02u)
	Read.
#define	CY_BLE_CHAR_PROP_WRITE_WITHOUT_RSP   (0x04u)
	Write Without Response.
#define	CY_BLE_CHAR_PROP_WRITE   (0x08u)
	Write.
#define	CY_BLE_CHAR_PROP_NOTIFY   (0x10u)
	Notify.
#define	CY_BLE_CHAR_PROP_INDICATE   (0x20u)
	Indicate.
#define	CY_BLE_CHAR_PROP_SIGNED_WRITE   (0x40u)
	Authenticated Signed Writes.
#define	CY_BLE_CHAR_PROP_EXTENDED_PROPERTIES   (0x80u)
	Extended properties.
#define	CY_BLE_CCCD_DEFAULT   (0x0000u)
	Notifications and Indications disabled.
#define	CY_BLE_CCCD_NOTIFICATION   (0x0001u)
	Notifications enabled.
#define	CY_BLE_CCCD_INDICATION   (0x0002u)
	Indications enabled.
#define	CY_BLE_CCCD_LEN   (0x02u)
	Length of CCCD desctiptor.
#define	CY_BLE_SCCD_DEFAULT   (0x0000u)
	Broadcasts disabled.
#define	CY_BLE_SCCD_BROADCAST   (0x0001u)
	Broadcasts enabled.
#define	CY_BLE_SCCD_LEN   (0x02u)
	Length of SCCD desctiptor.
#define	CY_BLE_CPFD_BOOLEAN   (0x01u)
	Unsigned 1-bit; 0=false, 1=true.
#define	CY_BLE_CPFD_UINT2   (0x02u)
	Unsigned 2-bit integer.
#define	CY_BLE_CPFD_UINT4   (0x03u)
	Unsigned 4-bit integer.
#define	CY_BLE_CPFD_UINT8   (0x04u)
	Unsigned 8-bit integer.
#define	CY_BLE_CPFD_UINT12   (0x05u)
	Unsigned 12-bit integer.
#define	CY_BLE_CPFD_UINT16   (0x06u)
	Unsigned 16-bit integer.
#define	CY_BLE_CPFD_UINT24   (0x07u)
	Unsigned 24-bit integer.
#define	CY_BLE_CPFD_UINT32   (0x08u)
	Unsigned 32-bit integer.
#define	CY_BLE_CPFD_UINT48   (0x09u)
	Unsigned 48-bit integer.
#define	CY_BLE_CPFD_UINT64   (0x0au)
	Unsigned 64-bit integer.
#define	CY_BLE_CPFD_UINT128   (0x0bu)
	Unsigned 128-bit integer.
#define	CY_BLE_CPFD_INT8   (0x0cu)
	Signed 8-bit integer.
#define	CY_BLE_CPFD_INT12   (0x0du)
	Signed 12-bit integer.
#define	CY_BLE_CPFD_INT16   (0x0eu)
	Signed 16-bit integer.
#define	CY_BLE_CPFD_INT24   (0x0fu)
	Signed 24-bit integer.
#define	CY_BLE_CPFD_INT32   (0x10u)
	Signed 32-bit integer.
#define	CY_BLE_CPFD_INT48   (0x11u)
	Signed 48-bit integer.
#define	CY_BLE_CPFD_INT64   (0x12u)
	Signed 64-bit integer.
#define	CY_BLE_CPFD_INT128   (0x13u)
	Signed 128-bit integer.
#define	CY_BLE_CPFD_IEEE754_FP32   (0x14u)
	IEEE-754 32-bit floating point.
#define	CY_BLE_CPFD_IEEE754_FP64   (0x15u)
	IEEE-754 64-bit floating point.
#define	CY_BLE_CPFD_IEEE11073_SFLOAT16   (0x16u)
	IEEE-11073 16-bit SFLOAT.
#define	CY_BLE_CPFD_IEEE11073_FLOAT32   (0x17u)
	IEEE-11073 32-bit FLOAT.
#define	CY_BLE_CPFD_IEEE20601_FORMAT   (0x18u)
	IEEE-20601 format.
#define	CY_BLE_CPFD_UTF8_STRING   (0x19u)
	UTF-8 string.
#define	CY_BLE_CPFD_UTF16_STRING   (0x1au)
	UTF-16 string.
#define	CY_BLE_CPFD_OPAQUE_STRUCTURE   (0x1bu)
	Opaque structure.
#define	CY_BLE_CPFD_LEN   (0x01u)
	Length of CPFD desctiptor.
#define	CY_BLE_CEPD_DEFAULT   (0x0000u)
	Writable Auxiliaries & Reliable Write disabled.
#define	CY_BLE_CEPD_RELIABLE_WRITE   (0x0001u)
	Reliable Write enabled.
#define	CY_BLE_CEPD_WRITABLE_AUXILIARIES   (0x0002u)
	Writable Auxiliaries enabled.
#define	CY_BLE_CEPD_LEN   (0x02u)
	Length of CEPD desctiptor.
#define	CY_BLE_DB_ATTR_HANDLE_LEN   (0x02u)
	Length of DB ATTR HANDLE.
#define	CY_BLE_PDU_DATA_LEN_ZERO   (0x00u)
	Zero.
#define	CY_BLE_PDU_DATA_LEN_ONE_BYTE   (0x01u)
	PDU len: 1 byte.
#define	CY_BLE_PDU_DATA_LEN_TWO_BYTES   (0x02u)
	PDU len: 2 bytes.
#define	CY_BLE_PDU_DATA_LEN_THREE_BYTES   (0x03u)
	PDU len: 3 bytes.
#define	CY_BLE_PDU_DATA_LEN_FOUR_BYTES   (0x04u)
	PDU len: 4 bytes.
#define	CY_BLE_PDU_DATA_LEN_FIVE_BYTES   (0x05u)
	PDU len: 5 bytes.
#define	CY_BLE_PDU_DATA_LEN_SIX_BYTES   (0x06u)
	PDU len: 6 bytes.
#define	CY_BLE_PDU_DATA_LEN_SEVEN_BYTES   (0x07u)
	PDU len: 7 bytes.
#define	CY_BLE_PDU_DATA_LEN_EIGHT_BYTES   (0x08u)
	PDU len: 8 bytes.
#define	CY_BLE_PDU_DATA_LEN_NINE_BYTES   (0x09u)
	PDU len: 9 bytes.
#define	CY_BLE_PPCPC_MIN_CONN_INTV_OFFSET   (0x00u)
	Offset of Minimum Connection Interval Field.
#define	CY_BLE_PPCPC_MAX_CONN_INTV_OFFSET   (0x02u)
	Offset of Maximum Connection Interval Field.
#define	CY_BLE_PPCPC_SLAVE_LATENCY_OFFSET   (0x04u)
	Offset of Slave Latency Field.
#define	CY_BLE_PPCPC_SUP_TIMEOUT_OFFSET   (0x06u)
	Offset of Connection Supervision Timeout Field.
#define	CY_BLE_PPCPC_LEN   (0x08u)
	Length of PPCPC desctiptor.
#define	CY_BLE_SMP_USER_PASSKEY_SIZE   (6u)
	User Passkey size.
#define	CY_BLE_SMP_IDADDR_SIZE   (7u)
	Identity Address data size.
#define	CY_BLE_SMP_IRK_SIZE   (16u)
	Identity Resolving Key size.
#define	CY_BLE_SMP_CSRK_SIZE   (16u)
	Connection Signature Resolving key size.
#define	CY_BLE_SMP_LTK_SIZE   (16u)
	Long Term Key Size size.
#define	CY_BLE_SMP_EDIV_SIZE   (2u)
	Encrypted Diversifier size.
#define	CY_BLE_SMP_RAND_24B_SIZE   (3u)
	24 Bit Random Number size
#define	CY_BLE_SMP_RAND_64B_SIZE   (8u)
	64 Bit Random Number size
#define	CY_BLE_SMP_RAND_128B_SIZE   (16u)
	128 Bit Random Number size
#define	CY_BLE_NULL_CHARCTER   ((char8)(0))
	Null charter.
#define	CY_BLE_NO_ALERT   (0u)
	Alert Level: No Alert.
#define	CY_BLE_MILD_ALERT   (1u)
	Alert Level: Mild Alert.
#define	CY_BLE_HIGH_ALERT   (2u)
	Alert Level: High Alert.

Macro Definition Documentation

CY_BLE_STACK_RAM_SIZE

#define CY_BLE_STACK_RAM_SIZE

Value:

(CY_BLE_ALIGN_TO_4(CY_BLE_DEFAULT_HOST_RAM_SIZE + CY_BLE_LL_CONTROLLER_HEAP_REQ_SOC +\
                                                    CY_BLE_RAM_SECURE_CONNECTIONS_SIZE + CY_BLE_L2CAP_Q_HEAP +          \
                                                    CY_BLE_STACK_BOND_RAM_SIZE +                                        \
                                                    (CY_BLE_GATT_MTU_PLUS_L2CAP_MEM_EXT * CY_BLE_GATT_MTU_BUFF_COUNT) + \
                                                    (CY_BLE_L2CAP_PSM_PLUS_L2CAP_MEM_EXT * CY_BLE_L2CAP_PSM_COUNT) +    \
                                                    (CY_BLE_L2CAP_CBFC_PLUS_L2CAP_MEM_EXT * 2u *                        \
                                                        CY_BLE_L2CAP_LOGICAL_CHANNEL_COUNT) +                           \
                                                    (CY_BLE_L2CAP_MTU_PLUS_L2CAP_MEM_EXT * 2u *                         \
                                                        CY_BLE_L2CAP_LOGICAL_CHANNEL_COUNT) +                           \
                                                    (CY_BLE_STACK_BUFFER_MGR_UTIL_RAM_SZ * CY_BLE_STACK_APP_MIN_POOL) + \
                                                    (CY_BLE_RAM_SIZE_HOST_SINGLE_CONN * CY_BLE_CONN_COUNT) +            \
                                                    CY_BLE_GATT_DB_ATTR_BUFF_SIZE +                                     \
                                                    (CY_BLE_GATT_PREPARE_WRITE_BUFF_LEN))) /* This buffer must always be the latest */

The size of RAM memory required for the Stack host.

CY_BLE_STACK_FLASH_SIZE

#define CY_BLE_STACK_FLASH_SIZE

Value:

(CY_BLE_STACK_BOND_FLASH_SIZE + CY_BLE_STACK_RESOLVING_LIST_SIZE + \
                                                     CY_BLE_STACK_WHITELIST_SIZE + CY_BLE_STACK_FLASH_CRC_SIZE )

The size of flash memory required for the bonding data.

CY_BLE_GAP_ADV_FLAG_LE_LIMITED_DISC_MODE

#define CY_BLE_GAP_ADV_FLAG_LE_LIMITED_DISC_MODE   (0x01u)

LE Limited Discoverable Mode.

CY_BLE_GAP_ADV_FLAG_LE_GENERAL_DISC_MODE

#define CY_BLE_GAP_ADV_FLAG_LE_GENERAL_DISC_MODE   (0x02u)

LE General Discoverable Mode.

CY_BLE_GAP_ADV_FLAG_BR_EDR_NOT_SUPPORTED

#define CY_BLE_GAP_ADV_FLAG_BR_EDR_NOT_SUPPORTED   (0x04u)

BR/EDR not supported.

CY_BLE_GAP_ADV_FLAG_LE_BR_EDR_CONTROLLER

#define CY_BLE_GAP_ADV_FLAG_LE_BR_EDR_CONTROLLER   (0x08u)

Simultaneous LE and BR/EDR, Controller.

CY_BLE_GAP_ADV_FLAG_LE_BR_EDR_HOST

#define CY_BLE_GAP_ADV_FLAG_LE_BR_EDR_HOST   (0x10u)

Simultaneous LE and BR/EDR, Host.

CY_BLE_GAP_ADV_ADVERT_INTERVAL_MIN

#define CY_BLE_GAP_ADV_ADVERT_INTERVAL_MIN   (0x0020u)

Minimum Advertising interval in 625 us units, i.e.

20 ms.

CY_BLE_GAP_ADV_ADVERT_INTERVAL_NONCON_MIN

#define CY_BLE_GAP_ADV_ADVERT_INTERVAL_NONCON_MIN   (0x00A0u)

Minimum Advertising interval in 625 us units for non connectable mode, i.e.

100 ms.

CY_BLE_GAP_ADV_ADVERT_INTERVAL_MAX

#define CY_BLE_GAP_ADV_ADVERT_INTERVAL_MAX   (0x4000u)

Maximum Advertising interval in 625 us units, i.e.

10.24 s.