wifi8.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 WIFI8_H
#define WIFI8_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_spi_master.h"
#include "wifi8_types.h"
 
#define WIFI8_MAP_MIKROBUS(cfg, mikrobus)         \
    cfg.miso = MIKROBUS(mikrobus, MIKROBUS_MISO); \
    cfg.mosi = MIKROBUS(mikrobus, MIKROBUS_MOSI); \
    cfg.sck = MIKROBUS(mikrobus, MIKROBUS_SCK);   \
    cfg.cs = MIKROBUS(mikrobus, MIKROBUS_CS);     \
    cfg.en = MIKROBUS(mikrobus, MIKROBUS_AN);     \
    cfg.rst = MIKROBUS(mikrobus, MIKROBUS_RST);   \
    cfg.wkp = MIKROBUS(mikrobus, MIKROBUS_PWM);   \
    cfg.int_pin = MIKROBUS(mikrobus, MIKROBUS_INT)
 
 // wifi8_map
 // wifi8
    
typedef struct
{
    // Output pins
    digital_out_t en;  
    digital_out_t rst; 
    digital_out_t wkp; 
    // Input pins
    digital_in_t int_pin; 
    // Modules
    spi_master_t spi; 
    pin_name_t chip_select; 
    uint8_t hif_bl_offset;
    wifi8_nm_state_t device_state;
    uint8_t ch_num;
    uint32_t hs_flags;
    wifi8_socket_t sockets[MAX_SOCKET];
    uint8_t root_sha1[20];
    uint16_t session_id;
    uint8_t socket_init;
    uint32_t ping_id;
    wifi8_app_wifi_cb_t app_wifi_cb;
    wifi8_app_socket_cb_t app_socket_cb;
    wifi8_app_resolve_cb_t app_resolve_cb;
    wifi8_ping_cb_t ping_cb;
 
} wifi8_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t miso; 
    pin_name_t mosi; 
    pin_name_t sck;  
    pin_name_t cs;   
    // Additional gpio pins
    pin_name_t en;      
    pin_name_t rst;     
    pin_name_t wkp;     
    pin_name_t int_pin; 
    // static variable
    uint32_t spi_speed;                            
    spi_master_mode_t spi_mode;                    
    spi_master_chip_select_polarity_t cs_polarity; 
} wifi8_cfg_t;
 
typedef void (*wifi8_hif_call_back_t)(wifi8_t *ctx, uint8_t u8_op_code, uint16_t u16_data_size, uint32_t u32_addr);
typedef wifi8_sock_addr_t wifi8_uip_sock_addr_t;
 
typedef struct
{
    uint8_t u8_chip_mode;
    uint8_t u8_chip_sleep;
    uint8_t u8_hif_rx_done;
    uint8_t u8_interrupt;
    uint8_t u8_yield;
    uint32_t u32_rx_addr;
    uint32_t u32_rx_size;
    wifi8_hif_call_back_t pf_wifi_cb;
    wifi8_hif_call_back_t pf_ip_cb;
    wifi8_hif_call_back_t pf_ota_cb;
    wifi8_hif_call_back_t pf_sigma_cb;
    wifi8_hif_call_back_t pf_hif_cb;
    wifi8_hif_call_back_t pf_crypto_cb;
    wifi8_hif_call_back_t pf_ssl_cb;
} wifi8_hif_context_t;
 
void wifi8_cfg_setup(wifi8_cfg_t *cfg);
 
err_t wifi8_init(wifi8_t *ctx, wifi8_cfg_t *cfg);
 
err_t wifi8_default_cfg(wifi8_t *ctx);
 
err_t wifi8_generic_write(wifi8_t *ctx, uint8_t *data_in, uint8_t len);
 
err_t wifi8_generic_read(wifi8_t *ctx, uint8_t *data_out, uint8_t len);
 
err_t wifi8_reg_write(wifi8_t *ctx, uint32_t addr, uint32_t data_in);
 
err_t wifi8_reg_read(wifi8_t *ctx, uint32_t addr, uint32_t *data_out);
 
err_t wifi8_block_read(wifi8_t *ctx, uint32_t addr, uint8_t *data_buf, uint16_t buf_len);
 
err_t wifi8_block_write(wifi8_t *ctx, uint32_t addr, uint8_t *data_buf, uint16_t buf_len);
 
err_t wifi8_init_drv(wifi8_t *ctx);
 
uint32_t wifi8_chip_id(wifi8_t *ctx);
 
err_t wifi8_get_full_firmware_version(wifi8_t *ctx, wifi8_m2m_rev_t *fw_version);
 
err_t wifi8_get_ota_firmware_version(wifi8_t *ctx, wifi8_m2m_rev_t *fw_version);
 
err_t wifi8_connect(wifi8_t *ctx, char *pc_ssid, uint8_t u8_ssid_len, wifi8_m2m_sec_type_t u8_sec_type, void *pv_auth_info, uint16_t u16_ch);
 
err_t wifi8_get_connection_info(wifi8_t *ctx);
 
err_t wifi8_start_ap(wifi8_t *ctx, wifi8_m2m_ap_config_t *pstr_m2m_ap_config);
 
err_t wifi8_req_scan_result(wifi8_t *ctx, uint8_t scan_request_index);
 
err_t wifi8_request_scan(wifi8_t *ctx, uint8_t channel);
 
err_t wifi8_handle_events(wifi8_t *ctx);
 
err_t wifi8_ble_api_send(wifi8_t *ctx, uint8_t *msg,  uint32_t len);
 
void wifi8_socket_init(wifi8_t *ctx);
 
err_t wifi8_socket_create(wifi8_t *ctx, uint16_t u16_domain, uint8_t u8_type, uint8_t u8_flags);
 
err_t wifi8_socket_bind(wifi8_t *ctx, int8_t sock, wifi8_sockaddr_t *pstr_addr, uint8_t u8_addr_len);
 
int8_t wifi8_socket_listen(wifi8_t *ctx, int8_t sock, uint8_t backlog);
 
err_t wifi8_socket_connect(wifi8_t *ctx, int8_t sock, wifi8_sockaddr_t *pstr_addr, uint8_t u8_addr_len);
 
err_t wifi8_socket_send(wifi8_t *ctx, int8_t sock, void *pv_send_buffer, uint16_t u16_send_length);
 
err_t wifi8_socket_send_to(wifi8_t *ctx, int8_t sock, void *pv_send_buffer, uint16_t u16_send_length, wifi8_sockaddr_t *pstr_dest_addr, uint8_t u8_addr_len);
 
err_t wifi8_socket_receive(wifi8_t *ctx, int8_t sock, void *pv_recv_buf, uint16_t u16_buf_len, uint32_t u32_timeoutmsec);
 
err_t wifi8_socket_receive_from(wifi8_t *ctx, int8_t sock, void *pv_recv_buf, uint16_t u16_buf_len, uint32_t u32_timeoutmsec);
 
err_t wifi8_socket_close(wifi8_t *ctx, int8_t sock);
 
#ifdef __cplusplus
}
#endif
#endif // WIFI8_H
 
 // wifi8
 
// ------------------------------------------------------------------------ END