ata8520e.h

Go to the documentation of this file.

/*
 * Copyright (C) 2017 Inria
 *
 * This file is subject to the terms and conditions of the GNU Lesser General
 * Public License v2.1. See the file LICENSE in the top level directory for more
 * details.
 */
 
#ifndef ATA8520E_H
#define ATA8520E_H
 
#include <stdint.h>
#include <inttypes.h>
#include "xtimer.h"
#include "periph/gpio.h"
#include "periph/spi.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define SIGFOX_PAC_LENGTH    (16U)  
#define SIGFOX_ID_LENGTH     (8U)   
#define SIGFOX_MAX_TX_LENGTH (12U)  
#define SIGFOX_RX_LENGTH     (8U)   
enum {
    ATA8520E_OK = 0,                
    ATA8520E_ERR_SPI,               
    ATA8520E_ERR_GPIO_INT,          
    ATA8520E_ERR_GPIO_RESET,        
    ATA8520E_ERR_GPIO_POWER,        
    ATA8520E_ERR_EVENT_TIMEOUT,     
};
 
enum {
    ATA8520E_STATE_IDLE,            
    ATA8520E_STATE_INIT,            
    ATA8520E_STATE_TX,              
    ATA8520E_STATE_RX,              
};
 
typedef enum {
    ATA8520E_SSM,                   
    ATA8520E_ATMEL,                 
    ATA8520E_SIGFOX                 
} ata8520e_status_type_t;
 
typedef enum {
    ATA8520E_ATMEL_OK,                      
    ATA8520E_ATMEL_COMMAND_ERROR,           
    ATA8520E_ATMEL_GENERIC_ERROR,           
    ATA8520E_ATMEL_FREQUENCY_ERROR,         
    ATA8520E_ATMEL_USAGE_ERROR,             
    ATA8520E_ATMEL_OPENING_ERROR,           
    ATA8520E_ATMEL_CLOSING_ERROR,           
    ATA8520E_ATMEL_SEND_ERROR               
} ata8520e_atmel_status_t;
 
typedef enum {
    ATA8520E_SIGFOX_OK,                      
    ATA8520E_SIGFOX_MANUFACTURER_ERROR,      
    ATA8520E_SIGFOX_ID_OR_KEY_ERROR,         
    ATA8520E_SIGFOX_STATE_MACHINE_ERROR,     
    ATA8520E_SIGFOX_FRAME_SIZE_ERROR,        
    ATA8520E_SIGFOX_MANUFACTURER_SEND_ERROR, 
    ATA8520E_SIGFOX_GET_VOLTAGE_TEMP_ERROR,  
    ATA8520E_SIGFOX_CLOSE_ERROR,             
    ATA8520E_SIGFOX_API_ERROR,               
    ATA8520E_SIGFOX_GET_PN9_ERROR,           
    ATA8520E_SIGFOX_GET_FREQUENCY_ERROR,     
    ATA8520E_SIGFOX_BUILDING_FRAME_ERROR,    
    ATA8520E_SIGFOX_DELAY_ROUTINE_ERROR,     
    ATA8520E_SIGFOX_CALLBACK_ERROR,          
    ATA8520E_SIGFOX_TIMING_ERROR,            
    ATA8520E_SIGFOX_FREQUENCY_ERROR          
} ata8520e_sigfox_status_t;
 
typedef struct {
    spi_t spi;                              
    spi_clk_t spi_clk;                      
    gpio_t cs_pin;                          
    gpio_t int_pin;                         
    gpio_t power_pin;                       
    gpio_t reset_pin;                       
} ata8520e_params_t;
 
typedef struct {
    ata8520e_params_t params;               
    uint8_t internal_state;                 
    uint8_t event_received;                 
    mutex_t event_lock;                     
} ata8520e_t;
 
int ata8520e_init(ata8520e_t *dev, const ata8520e_params_t *params);
 
void ata8520e_system_reset(const ata8520e_t *dev);
 
void ata8520e_read_atmel_version(const ata8520e_t *dev, uint8_t *version);
 
void ata8520e_read_sigfox_version(const ata8520e_t *dev, char *version);
 
void ata8520e_read_pac(const ata8520e_t *dev, char *pac);
 
void ata8520e_read_id(const ata8520e_t *dev, char *id);
 
int ata8520e_send_frame(ata8520e_t *dev, uint8_t *payload, uint8_t payload_len);
 
int ata8520e_send_receive_frame(ata8520e_t *dev, uint8_t *payload,
                                uint8_t payload_len, uint8_t *rx_payload);
 
int ata8520e_send_bit(ata8520e_t *dev, bool bit);
 
#ifdef __cplusplus
}
#endif
 
#endif /* ATA8520E_H */