ra8_ble.h

Go to the documentation of this file.

 
#pragma once
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
 
#include "ra8_err.h"
 
/* =============================================================================
 * Public limits
 * =============================================================================
 */

typedef enum : uint16_t {
  k_ra8_ble_max_cmd_params  = 255U, 
  k_ra8_ble_max_evt_params  = 255U, 
  k_ra8_ble_max_acl_payload = 251U, 
  k_ra8_ble_addr_bytes      = 6U,   
  k_ra8_ble_adv_data_max    = 31U,  
} ra8_ble_limits_t;

typedef enum : uint8_t {
  k_ra8_ble_pkt_cmd      = 0x01U, 
  k_ra8_ble_pkt_acl_data = 0x02U, 
  k_ra8_ble_pkt_event    = 0x04U, 
} ra8_ble_hci_pkt_t;
 
/* =============================================================================
 * Configuration
 * =============================================================================
 */

typedef struct {
  uint8_t use_external_osc;  
  uint8_t deep_sleep_enable; 
} ra8_ble_config_t;
 
/* =============================================================================
 * Callback typedefs
 * =============================================================================
 */

typedef void (*ra8_ble_event_fn_t)(void*          ctx,
                                   uint8_t        evt_code,
                                   const uint8_t* params,
                                   uint8_t        params_len);

typedef void (*ra8_ble_acl_fn_t)(void* ctx, uint16_t handle, const uint8_t* payload, uint16_t len);
 
/* =============================================================================
 * Lifecycle
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_ble_open(const ra8_ble_config_t* cfg);

[[nodiscard]] ra8_err_t ra8_ble_close(void);
 
/* =============================================================================
 * Raw HCI traffic
 * =============================================================================
 */

[[nodiscard]] ra8_err_t
ra8_ble_hci_send_command(uint16_t opcode, const uint8_t* params, uint8_t params_len);

[[nodiscard]] ra8_err_t
ra8_ble_hci_send_acl_data(uint16_t handle, const uint8_t* payload, uint16_t len);
 
/* =============================================================================
 * Receive callbacks
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_ble_attach_event_handler(ra8_ble_event_fn_t fn, void* ctx);

[[nodiscard]] ra8_err_t ra8_ble_attach_acl_handler(ra8_ble_acl_fn_t fn, void* ctx);

[[nodiscard]] ra8_err_t ra8_ble_dispatch(void);
 
/* =============================================================================
 * Convenience wrappers (HCI LE commands)
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_ble_set_random_address(const uint8_t addr[k_ra8_ble_addr_bytes]);

[[nodiscard]] ra8_err_t ra8_ble_set_advertising_data(const uint8_t* data, uint8_t len);

[[nodiscard]] ra8_err_t ra8_ble_set_advertising_enable(uint8_t enable);

[[nodiscard]] ra8_err_t ra8_ble_scan_start(uint8_t active, uint16_t interval, uint16_t window);
 
#ifdef __cplusplus
}
#endif