Memory management

This section defines the macros and API prototypes related to memory configuration. More...

Overview

This section defines the macros and API prototypes related to memory configuration.

Apply memory configuration after the system boots up.

How to use this module

• Call the function bt_memory_init_packet() to assign buffers for the Bluetooth stack. There are two buffers. One is the BT_MEMORY_TX_BUFFER buffer to send commands and application data to the controller with a recommended size from 256 to 512 bytes. The other is the BT_MEMORY_RX_BUFFER buffer to receive events and application data from the controller with a recommended size from 512 to 1024 bytes.
• Call the function bt_memory_init_control_block() to assign buffers with fixed block size for the Bluetooth stack. There are two buffers. One is the BT_MEMORY_CONTROL_BLOCK_TIMER buffer for the software timer usage in the Bluetooth stack. The other is the BT_MEMORY_CONTROL_BLOCK_LE_CONNECTION buffer to store connection information in the stack.
  • Sample code:

    #define BT_CONNECTION_MAX   5
    #define BT_TIMER_NUM 10
    #define BT_TX_BUF_SIZE 512
    #define BT_RX_BUF_SIZE 1024
    #define BT_TIMER_BUF_SIZE (BT_TIMER_NUM * BT_CONTROL_BLOCK_SIZE_OF_TIMER) // For more details, please refer to BT_CONTROL_BLOCK_SIZE_OF_TIMER.
    #define BT_CONNECTION_BUF_SIZE (BT_CONNECTION_MAX* BT_CONTROL_BLOCK_SIZE_OF_LE_CONNECTION) // For more details, please refer to BT_CONTROL_BLOCK_SIZE_OF_LE_CONNECTION.
    static char timer_cb_buf[BT_TIMER_BUF_SIZE];
    static char connection_cb_buf[BT_CONNECTION_BUF_SIZE];
    static char tx_buf[BT_TX_BUF_SIZE];
    static char rx_buf[BT_RX_BUF_SIZE];
    bt_bd_addr_t local_public_addr = {0x11, 0x22, 0x33, 0x44, 0x55, 0x66}; // Initialize the public_addr according to your requirement based on application.
    
    // Call memory initialization and task creation in the bt_create_task() only once.
    static void bt_create_task(void)
    {
         //Configurate the radio transmission power level for bt and le connections. the transmission power settings is not mandatory. 
         bt_config_tx_power_t tx_config_data = {.bt_init_tx_power_level = 5,
                                                .bt_max_tx_power_level = 6,
                                                .le_init_tx_power_level = 6};
         bt_config_tx_power_level(&tx_power_info);
         
         //Configurate the memory blocks.
         bt_memory_init_packet(BT_MEMORY_TX_BUFFER, tx_buf, BT_TX_BUF_SIZE);
         bt_memory_init_packet(BT_MEMORY_RX_BUFFER, rx_buf, BT_RX_BUF_SIZE);
         bt_memory_init_control_block(BT_MEMORY_CONTROL_BLOCK_TIMER, timer_cb_buf, BT_TIMER_BUF_SIZE);
         bt_memory_init_control_block(BT_MEMORY_CONTROL_BLOCK_LE_CONNECTION, connection_cb_buf,
                           BT_CONNECTION_BUF_SIZE);
    
         // Create a Bluetooth task. The Bluetooth will power on automatically after the task is created.
         if (pdPASS != xTaskCreate(bt_task, "bt_task", 2048, (void *)local_public_addr, 5, NULL)) {
             printf("Cannot create a bt_task.");
         }
    }

Functions
void	bt_memory_init_packet (bt_memory_packet_t type, char *buf, uint32_t size)
	This function initializes a TX/RX packet buffer for the Bluetooth stack. More...
void	bt_memory_init_control_block (bt_memory_control_block_t type, char *buf, uint32_t size)
	This function initializes a control block buffer for the Bluetooth stack. More...

Modules
	Define
	Struct

Function Documentation

void bt_memory_init_control_block	(	bt_memory_control_block_t	type,
		char *	buf,
		uint32_t	size
	)

This function initializes a control block buffer for the Bluetooth stack.

Parameters

[in]	type	is BT_MEMORY_CONTROL_BLOCK_TIMER or BT_MEMORY_CONTROL_BLOCK_LE_CONNECTION.
[in]	buf	is a pointer to the buffer.
[in]	size	is the size of the buffer, in bytes.

Returns

void.

void bt_memory_init_packet	(	bt_memory_packet_t	type,
		char *	buf,
		uint32_t	size
	)

This function initializes a TX/RX packet buffer for the Bluetooth stack.

Parameters

[in]	type	is BT_MEMORY_TX_BUFFER or BT_MEMORY_RX_BUFFER.
[in]	buf	is a pointer to the buffer.
[in]	size	is the size of the buffer in bytes.

Returns

void.