mac.h

Go to the documentation of this file.

#ifndef _MAC_H_
#define _MAC_H_

#include <stdint.h>

#define MAC_PORT_MAC_COMMAND    0
#define MAC_PORT_FIRST_APP  1

typedef enum {
    UNDEF_MAC = -1,                 
    PICOMAC = 0,                    
    LORAMAC = 1,                    
} mac_type_t;

typedef enum {
    DL_DISABLED = 0,                
    DL_ENABLED = 1,                 
} downlink_mode_t;

enum ack_status {
    UNDEF_ACK,
    NO_ACK,
    ACK
};

typedef enum e_device_class {
    CLASS_A,
    CLASS_B,
    CLASS_C,
} device_class_t;


typedef enum {
    MAC_STATE_IDLE = 0,             
    MAC_STATE_SEARCHING_NETWORK = 1,        
    MAC_STATE_SENDING_DATA = 2,         
    MAC_STATE_WAITING_ACK = 3,          
    MAC_STATE_WAITING_RETRY = 4,            
    MAC_STATE_WAITING_DATA = 5,         
} mac_state_t;

typedef enum {
    MAC_INFO_STATUS_DUTY_CYCLE_LIMITATION = -8, 
    MAC_INFO_STATUS_DOWNLINK_DECODING_ERROR = -7,   
    MAC_INFO_STATUS_DOWNLINK_TIMEOUT = -6,      
    MAC_INFO_STATUS_RX_ERROR = -5,          
    MAC_INFO_STATUS_TX_MAX_MSG_SIZE_EXCEEDED = -4,  
    MAC_INFO_STATUS_MIC_FAILED = -3,        
    MAC_INFO_STATUS_BEACON_TIMEOUT = -2,        
    MAC_INFO_STATUS_TX_ACK_TIMEOUT = -1,        
    MAC_INFO_STATUS_OK = 0,             
    MAC_INFO_STATUS_JOIN_ACCEPT_OK = 1,     
} mac_info_status_t;

typedef enum {
    NETWORK_UNAVAILABLE = 0,            
    NETWORK_AVAILABLE = 1,              
    NETWORK_UNKNOWN = 2,                
} mac_network_status_t;

typedef enum {
    MAC_STATUS_NOTHING_TO_SEND = -8,        
    MAC_STATUS_DEVICE_OFF = -7,         
    MAC_STATUS_BUSY = -6,               
    MAC_STATUS_FUNCTION_NOT_FOUND = -5,     
    MAC_STATUS_NOT_INITIALIZED = -4,        
    MAC_STATUS_MSG_LENGTH_ERROR = -3,       
    MAC_STATUS_MSG_HEADER_ERROR = -2,       
    MAC_STATUS_NO_NETWORK_JOINED = -1,      
    MAC_STATUS_NO_ERROR = 0,            
} mac_status_t;

typedef struct {
    mac_info_status_t status;
    enum ack_status ack_status;
    uint8_t nb_retries;
} mac_tx_info_t;

typedef struct {
    mac_info_status_t status;
    uint8_t port;                   
    uint8_t *payload;               
    uint8_t payload_len;                
    int16_t rssi;                   
    int8_t snr;                 
} mac_rx_info_t;

typedef struct {
    mac_network_status_t status;
} mac_network_info_t;

typedef struct {
    void (*mac_tx_done)(mac_tx_info_t *info);

    void (*mac_rx_done)(mac_rx_info_t *info);

    void (*mac_network_state)(mac_network_info_t *info);

    void (*mac_state)(mac_state_t state);

} mac_message_callbacks_t;

typedef struct {
    uint8_t (*get_battery_level)(void);
} mac_battery_callback_t;

typedef struct {
    uint32_t (*get_uplink_counter)(void);

    void (*save_uplink_counter)(uint32_t uplink_counter);

    uint32_t (*get_downlink_counter)(void);

    void (*save_downlink_counter)(uint32_t downlink_counter);
} mac_flash_callback_t;


mac_status_t mac_init(mac_type_t mac, mac_message_callbacks_t *cb, mac_battery_callback_t *battery_cb, mac_flash_callback_t *flash_cbs);

mac_status_t mac_deinit(void);

mac_status_t mac_init_activation_personalization(uint32_t netid, uint32_t devaddr, uint8_t *nwkskey, uint8_t *appskey);

mac_status_t mac_init_activation_on_air(uint8_t *dev_eui, uint8_t *app_eui, uint8_t *app_key);

mac_status_t mac_send_when_possible(uint8_t port, uint8_t *payload, uint8_t payload_len, downlink_mode_t dl_mode);

mac_status_t mac_send_when_possible_confirmed(uint8_t port, uint8_t *payload, uint8_t payload_len, uint8_t nb_retries, downlink_mode_t dl_mode);

mac_status_t mac_network_available(void);

mac_status_t mac_set_device_class(device_class_t device_class);

mac_status_t mac_get_device_address(uint32_t *device_address);

uint16_t mac_message_max_payload_length(void);

mac_type_t mac_get_stack(void);

#endif /* _MAC_H_ */