wirepas.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/
 
#ifndef WIREPAS_H
#define WIREPAS_H
 
#ifdef __cplusplus
extern "C"{
#endif
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_uart.h"
 
#define WIREPAS_DSAP_DATA_TX_REQUEST            0x01
#define WIREPAS_DSAP_DATA_TX_CONFIRM            0x81
#define WIREPAS_DSAP_DATA_TX_TT_REQUEST         0x1F
#define WIREPAS_DSAP_DATA_TX_TT_CONFIRM         0x9F
#define WIREPAS_DSAP_DATA_TX_INDICATION         0x02
#define WIREPAS_DSAP_DATA_TX_RESPONSE           0x82
#define WIREPAS_DSAP_DATA_RX_INDICATION         0x03
#define WIREPAS_DSAP_DATA_RX_RESPONSE           0x83
 
#define WIREPAS_MSAP_INDICATION_POLL_REQUEST    0x04
#define WIREPAS_MSAP_INDICATION_POLL_CONFIRM    0x84
#define WIREPAS_MSAP_STACK_START_REQUEST        0x05
#define WIREPAS_MSAP_STACK_START_CONFIRM        0x85
#define WIREPAS_MSAP_STACK_STOP_REQUEST         0x06
#define WIREPAS_MSAP_STACK_STOP_CONFIRM         0x86
#define WIREPAS_MSAP_STACK_STATE_INDICATION     0x07
#define WIREPAS_MSAP_STACK_STATE_RESPONSE       0x87
#define WIREPAS_MSAP_APP_CONFIG_DATA_RX_IND     0x3F
#define WIREPAS_MSAP_APP_CONFIG_DATA_RX_RESP    0xBF
#define WIREPAS_MSAP_SCAN_NBORS_INDICATION      0x22
#define WIREPAS_MSAP_SCAN_NBORS_RESPONSE        0xA2
 
#define WIREPAS_CSAP_ATTRIBUTE_WRITE_REQUEST    0x0D
#define WIREPAS_CSAP_ATTRIBUTE_WRITE_CONFIRM    0x8D
#define WIREPAS_CSAP_ATTRIBUTE_READ_REQUEST     0x0E
#define WIREPAS_CSAP_ATTRIBUTE_READ_CONFIRM     0x8E
#define WIREPAS_CSAP_FACTORY_RESET_REQUEST      0x16
#define WIREPAS_CSAP_FACTORY_RESET_CONFIRM      0x96
 
#define WIREPAS_CSAP_ATTRIBUTE_NODE_ADDRESS     0x01
#define WIREPAS_CSAP_ATTRIBUTE_NETWORK_ADDRESS  0x02
#define WIREPAS_CSAP_ATTRIBUTE_NETWORK_CHANNEL  0x03
#define WIREPAS_CSAP_ATTRIBUTE_NODE_ROLE        0x04
 
#define WIREPAS_FACTORY_RESET_CODE              "DoIt"
 
#define WIREPAS_ENDCODE_OCTET                   0xC0
 
#define WIREPAS_ROUTER_NODE_MODE                0x02    
#define WIREPAS_SINK_NODE_MODE                  0x01    
 
#define WIREPAS_PIN_MODE_HIGH                   0x01    
#define WIREPAS_PIN_MODE_LOW                    0x00    
 
#define WIREPAS_TX_DRV_BUFFER_SIZE              200
#define WIREPAS_RX_DRV_BUFFER_SIZE              500
 
 // wirepas_cmd
 
#define WIREPAS_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
    cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.din = MIKROBUS( mikrobus, MIKROBUS_INT );
 
 // wirepas_map
 // wirepas
 
typedef struct
{
    uint8_t primitive_id;                    
    uint8_t frame_id;                 
    uint8_t payload_len;               
    uint8_t payload[ 256 ];            
 
} wirepas_frame_t;
 
typedef struct
{
    // Output pins
    digital_out_t rst;   
    // Input pins
    digital_in_t din;    
    // Modules
    uart_t uart;         
    // Buffers
    uint8_t uart_rx_buffer[ WIREPAS_RX_DRV_BUFFER_SIZE ];  
    uint8_t uart_tx_buffer[ WIREPAS_TX_DRV_BUFFER_SIZE ];  
    wirepas_frame_t frame;
    uint8_t tx_frame_id;
 
} wirepas_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t rx_pin;                          
    pin_name_t tx_pin;                          
    // Additional gpio pins
    pin_name_t rst;                             
    pin_name_t din;                             
    // Static variable
    uint32_t         baud_rate;                 
    bool             uart_blocking;             
    uart_data_bits_t data_bit;                  
    uart_parity_t    parity_bit;                
    uart_stop_bits_t stop_bit;                  
} wirepas_cfg_t;
 
typedef struct
{
    uint16_t pduid;                             
    uint8_t source_endpoint;                    
    uint32_t destination_addr;                  
    uint8_t destination_endpoint;               
} wirepas_sink_data;
 
typedef enum
{
    WIREPAS_OK = 0,
    WIREPAS_DATA_RDY = 1,
    WIREPAS_ERROR = -1
 
} wirepas_return_value_t;
 
void wirepas_cfg_setup ( wirepas_cfg_t *cfg );
 
err_t wirepas_init ( wirepas_t *ctx, wirepas_cfg_t *cfg );
 
void wirepas_default_cfg ( wirepas_t *ctx );
 
err_t wirepas_generic_write ( wirepas_t *ctx, uint8_t *data_in, uint16_t len );
 
err_t wirepas_generic_read ( wirepas_t *ctx, uint8_t *data_out, uint16_t len );
 
uint8_t wirepas_get_din_state ( wirepas_t *ctx );
 
void wirepas_set_rst ( wirepas_t *ctx, uint8_t pin_state );
 
void wirepas_hw_reset ( wirepas_t *ctx );
 
err_t wirepas_send_command ( wirepas_t *ctx, uint8_t primitive_id,  
                             uint8_t payload_length, uint8_t *payload );
 
err_t wirepas_send_ack ( wirepas_t *ctx, uint8_t primitive_id, uint8_t frame_id, uint8_t result );
 
err_t wirepas_write_csap_attribute ( wirepas_t *ctx, uint16_t attribute_id, 
                                     uint8_t attribute_len, uint8_t *attribute_val );
 
err_t wirepas_read_csap_attribute ( wirepas_t *ctx, uint16_t attribute_id, 
                                    uint8_t *attribute_len, uint8_t *attribute_val );
 
err_t wirepas_set_node_address ( wirepas_t *ctx, uint32_t address );
 
err_t wirepas_set_net_address ( wirepas_t *ctx, uint32_t net_address );
 
err_t wirepas_read_frame ( wirepas_t *ctx, wirepas_frame_t *frame );
 
err_t wirepas_send_data ( wirepas_t *ctx, wirepas_sink_data sink_data, 
                          uint8_t tx_op, uint8_t apdu_length, uint8_t *apdu );
 
#ifdef __cplusplus
}
#endif
#endif // WIREPAS_H
 
 // wirepas
 
// ------------------------------------------------------------------------ END