nrf_scan.h

Go to the documentation of this file.

/*
 * Copyright (c) 2025 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
 
#ifndef NRF_SCAN_H__
#define NRF_SCAN_H__
 
#include <stdbool.h>
#include <stdint.h>
// #include "nrf_config_scan.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum
{
    NRF_SCAN_EVT_TX_COMPLETE,   
    NRF_SCAN_EVT_RX_COMPLETE,   
    NRF_SCAN_EVT_ERROR,         
    NRF_SCAN_EVT_STATE_CHANGED, 
} nrf_scan_event_type_t;
 
typedef enum
{
    NRF_SCAN_MODE_NORMAL = 0, 
    NRF_SCAN_MODE_LOOPBACK,   
    NRF_SCAN_MODE_LISTENONLY, 
    NRF_SCAN_MODE_ONESHOT,    
} nrf_scan_mode_type_t;
 
typedef enum
{
    NRF_SCAN_SUCCESS = 0,
    NRF_SCAN_ERROR_PROTOCOL,           
    NRF_SCAN_ERROR_BIT_STUFFING_ERROR, 
    NRF_SCAN_ERROR_BIT0_ERROR,         
    NRF_SCAN_ERROR_BIT1_ERROR,         
    NRF_SCAN_ERROR_FORM_ERROR,         
    NRF_SCAN_ERROR_ACK_ERROR,          
    NRF_SCAN_ERROR_CRC_ERROR,          
    NRF_SCAN_ERROR_BUSY,               
    NRF_SCAN_ERROR_UNSUPPORTED,        
    NRF_SCAN_ERROR_INVALID_PARAM,      
    NRF_SCAN_ERROR_INVALID_STATE,      
} nrf_scan_error_t;
 
typedef enum
{
    NRF_SCAN_STATE_ERROR_ACTIVE = 0, 
    NRF_SCAN_STATE_ERROR_WARNING,    
    NRF_SCAN_STATE_ERROR_PASSIVE,    
    NRF_SCAN_STATE_BUS_OFF,          
    NRF_SCAN_STATE_STOPPED,          
} nrf_scan_state_t;
 
typedef void (* nrf_scan_event_handler_t)(nrf_scan_event_type_t const * p_event,
                                          void *                        p_context);
 
typedef struct
{
    uint16_t sp_identifier;        
    uint16_t
             last_updated_mailbox; 
} nrf_scan_context_t;
 
typedef struct
{
    uint16_t sjw;        
    uint16_t prop_seg;   
    uint16_t phase_seg1; 
    uint16_t phase_seg2; 
    uint16_t prescaler;  
} nrf_scan_timing_t;
 
typedef struct
{
    uint32_t identifier;  
    uint8_t  data_length; 
    uint8_t  ide;         
    uint8_t  rtr;         
    uint8_t  data[8];
} nrf_scan_frame_t;
 
typedef struct
{
    uint32_t id;   
    uint32_t mask; 
} nrf_scan_rx_filter_t;
 
typedef struct
{
    nrf_scan_frame_t     rx_frame;  
    nrf_scan_rx_filter_t rx_filter; 
    bool                 ready;     
} nrf_scan_rx_mailbox_t;
 
extern nrf_scan_rx_mailbox_t m_scan_rx_mailbox[];
 
typedef struct
{
    void * p_reg;        
    uint8_t
           drv_inst_idx; 
} nrf_scan_t;
 
typedef struct
{
    nrf_scan_error_t error; 
    nrf_scan_state_t state; 
} nrf_scan_status_t;
 
nrf_scan_status_t nrf_scan_get_status(nrf_scan_t const * p_scan);
 
nrf_scan_error_t nrf_scan_init(nrf_scan_t const *       p_scan,
                               nrf_scan_event_handler_t handler,
                               void *                   p_context);
 
void nrf_scan_uninit(nrf_scan_t const * p_scan);
 
nrf_scan_error_t nrf_scan_enable(nrf_scan_t const * p_scan);
 
nrf_scan_error_t nrf_scan_disable(nrf_scan_t const * p_scan);
 
nrf_scan_error_t nrf_scan_timing(nrf_scan_t const *        p_scan,
                                 nrf_scan_timing_t const * p_timing);
 
nrf_scan_error_t nrf_scan_mode(nrf_scan_t const * p_scan, nrf_scan_mode_type_t * p_mode);
 
nrf_scan_error_t nrf_scan_set_rx_filter(nrf_scan_t const *           p_scan,
                                        nrf_scan_rx_filter_t const * p_rxfilter,
                                        uint8_t                      index);
 
nrf_scan_error_t nrf_scan_disable_rx_filter(nrf_scan_t const * p_scan, uint8_t index);
 
nrf_scan_error_t nrf_scan_enable_rx_filter(nrf_scan_t const * p_scan, uint8_t index);
 
nrf_scan_error_t nrf_scan_unlock_rx_mailbox(nrf_scan_t const * p_scan, uint8_t index);
 
nrf_scan_error_t nrf_scan_send(nrf_scan_t const * p_scan,
                               nrf_scan_frame_t * p_tx_frame);
 
nrf_scan_error_t nrf_scan_abort(nrf_scan_t const * p_scan);
 
void nrf_scan_irq_handler(void);
 
#ifdef __cplusplus
}
#endif
 
#endif // NRF_SCAN_H__