KDDI Fx0 hackathon / SNICInterface_mod

SNIC UART Interface library for Murata Type-YD module

Dependents:   WebSocketServerTest

Fork of SNICInterface_mod by Toyomasa Watarai

SNIC/SNIC_Core.h@23:4ff2231ff9ba, 2014-03-27 (annotated)

Committer:
kishino
Date:
Thu Mar 27 10:11:59 2014 +0000
Revision:
23:4ff2231ff9ba
Parent:
22:a9ec0cad4f84
Child:
25:67183ed15708
Modified the description of classes.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
kishino 20:dd736d328de6 1 /******************* Murata Manufacturing Co.,Ltd. 2014 *****************
kishino 20:dd736d328de6 2 *
kishino 20:dd736d328de6 3 * Filename: SNIC_Core.h
kishino 20:dd736d328de6 4 *
kishino 20:dd736d328de6 5 * Purpose: This module has define of internal common function for API.
kishino 20:dd736d328de6 6 *
kishino 20:dd736d328de6 7 * $Author: kishino $
kishino 20:dd736d328de6 8 *
kishino 20:dd736d328de6 9 * $Date: 2014/03/26 $
kishino 20:dd736d328de6 10 *
kishino 20:dd736d328de6 11 * $Revision: 0.0.0.1 $
kishino 20:dd736d328de6 12 * ***********************************************************************/
kishino 20:dd736d328de6 13 #ifndef _SNIC_CORE_H_
kishino 20:dd736d328de6 14 #define _SNIC_CORE_H_
kishino 20:dd736d328de6 15
kishino 20:dd736d328de6 16 #include "mbed.h"
kishino 20:dd736d328de6 17 #include "rtos.h"
kishino 20:dd736d328de6 18 #include "RawSerial.h"
kishino 20:dd736d328de6 19 #include "CBuffer.h"
kishino 20:dd736d328de6 20
kishino 20:dd736d328de6 21 #include "SNIC_UartCommandManager.h"
kishino 20:dd736d328de6 22
kishino 20:dd736d328de6 23 namespace murata_wifi
kishino 20:dd736d328de6 24 {
kishino 20:dd736d328de6 25 #define UART_REQUEST_PAYLOAD_MAX 256
kishino 20:dd736d328de6 26
kishino 20:dd736d328de6 27 #define MEMPOOL_BLOCK_SIZE 2048
kishino 20:dd736d328de6 28 #define MEMPOOL_PAYLOAD_NUM 1
kishino 20:dd736d328de6 29 #define MAX_SOCKET_ID 5
kishino 20:dd736d328de6 30
kishino 20:dd736d328de6 31 /** Wi-Fi security
kishino 20:dd736d328de6 32 */
kishino 20:dd736d328de6 33 typedef enum SECURITY {
kishino 20:dd736d328de6 34 /** Securiry Open */
kishino 20:dd736d328de6 35 e_SEC_OPEN = 0x00,
kishino 20:dd736d328de6 36 /** Securiry WEP */
kishino 20:dd736d328de6 37 e_SEC_WEP = 0x01,
kishino 20:dd736d328de6 38 /** Securiry WPA-PSK(TKIP) */
kishino 20:dd736d328de6 39 e_SEC_WPA_TKIP = 0x02,
kishino 20:dd736d328de6 40 /** Securiry WPA2-PSK(AES) */
kishino 20:dd736d328de6 41 e_SEC_WPA2_AES = 0x04,
kishino 20:dd736d328de6 42 /** Securiry WPA2-PSK(TKIP/AES) */
kishino 20:dd736d328de6 43 e_SEC_WPA2_MIXED = 0x06,
kishino 20:dd736d328de6 44 /** Securiry WPA-PSK(AES) */
kishino 20:dd736d328de6 45 e_SEC_WPA_AES = 0x07
kishino 20:dd736d328de6 46 }E_SECURITY;
kishino 20:dd736d328de6 47
kishino 20:dd736d328de6 48 /** Wi-Fi status
kishino 20:dd736d328de6 49 */
kishino 20:dd736d328de6 50 typedef enum WIFI_STATUS {
kishino 20:dd736d328de6 51 /** Wi-Fi OFF */
kishino 20:dd736d328de6 52 e_STATUS_OFF = 0,
kishino 20:dd736d328de6 53 /** No network */
kishino 20:dd736d328de6 54 e_NO_NETWORK,
kishino 20:dd736d328de6 55 /** Connected to AP (STA mode) */
kishino 20:dd736d328de6 56 e_STA_JOINED,
kishino 20:dd736d328de6 57 /** Started on AP mode */
kishino 20:dd736d328de6 58 e_AP_STARTED
kishino 20:dd736d328de6 59 }E_WIFI_STATUS;
kishino 20:dd736d328de6 60
kishino 23:4ff2231ff9ba 61 /** Internal class used by any other classes. This class is singleton.
kishino 20:dd736d328de6 62 */
kishino 20:dd736d328de6 63 class C_SNIC_Core
kishino 20:dd736d328de6 64 {
kishino 21:dda155fe5048 65 friend class C_SNIC_UartCommandManager;
kishino 21:dda155fe5048 66 friend class C_SNIC_WifiInterface;
kishino 21:dda155fe5048 67 friend class TCPSocketConnection;
kishino 21:dda155fe5048 68 friend class Socket;
kishino 21:dda155fe5048 69
kishino 21:dda155fe5048 70 private:
kishino 22:a9ec0cad4f84 71 /** Memorypool for SNIC UART Response
kishino 22:a9ec0cad4f84 72 */
kishino 22:a9ec0cad4f84 73 typedef struct
kishino 22:a9ec0cad4f84 74 {
kishino 22:a9ec0cad4f84 75 unsigned char buf[MEMPOOL_BLOCK_SIZE];
kishino 22:a9ec0cad4f84 76 }tagMEMPOOL_BLOCK_T;
kishino 22:a9ec0cad4f84 77
kishino 22:a9ec0cad4f84 78 /** Wi-Fi Network type
kishino 22:a9ec0cad4f84 79 */
kishino 22:a9ec0cad4f84 80 typedef enum NETWORK_TYPE {
kishino 22:a9ec0cad4f84 81 /** Infrastructure */
kishino 22:a9ec0cad4f84 82 e_INFRA = 0,
kishino 22:a9ec0cad4f84 83 /** Adhoc */
kishino 22:a9ec0cad4f84 84 e_ADHOC = 1
kishino 22:a9ec0cad4f84 85 }E_NETWORK_TYPE;
kishino 22:a9ec0cad4f84 86
kishino 22:a9ec0cad4f84 87 /** Connection information
kishino 22:a9ec0cad4f84 88 */
kishino 22:a9ec0cad4f84 89 typedef struct {
kishino 22:a9ec0cad4f84 90 CircBuffer<unsigned char> *recvbuf_p;
kishino 22:a9ec0cad4f84 91 bool is_connected;
kishino 22:a9ec0cad4f84 92 bool is_received;
kishino 22:a9ec0cad4f84 93 }tagCONNECT_INFO_T;
kishino 22:a9ec0cad4f84 94
kishino 22:a9ec0cad4f84 95 /** GEN_FW_VER_GET_REQ Command */
kishino 22:a9ec0cad4f84 96 typedef struct
kishino 22:a9ec0cad4f84 97 {
kishino 22:a9ec0cad4f84 98 unsigned char cmd_sid;
kishino 22:a9ec0cad4f84 99 unsigned char seq;
kishino 22:a9ec0cad4f84 100 }tagGEN_FW_VER_GET_REQ_T;
kishino 22:a9ec0cad4f84 101
kishino 22:a9ec0cad4f84 102 /** SNIC_INIT_REQ */
kishino 22:a9ec0cad4f84 103 typedef struct
kishino 22:a9ec0cad4f84 104 {
kishino 22:a9ec0cad4f84 105 unsigned char cmd_sid;
kishino 22:a9ec0cad4f84 106 unsigned char seq;
kishino 22:a9ec0cad4f84 107 unsigned short buf_size;
kishino 22:a9ec0cad4f84 108 }tagSNIC_INIT_REQ_T;
kishino 22:a9ec0cad4f84 109
kishino 22:a9ec0cad4f84 110 /** SNIC_TCP_CREATE_SOCKET_REQ */
kishino 22:a9ec0cad4f84 111 typedef struct
kishino 22:a9ec0cad4f84 112 {
kishino 22:a9ec0cad4f84 113 unsigned char cmd_sid;
kishino 22:a9ec0cad4f84 114 unsigned char seq;
kishino 22:a9ec0cad4f84 115 unsigned char bind;
kishino 22:a9ec0cad4f84 116 unsigned char local_addr[4];
kishino 22:a9ec0cad4f84 117 unsigned char local_port[2];
kishino 22:a9ec0cad4f84 118 }tagSNIC_TCP_CREATE_SOCKET_REQ_T;
kishino 22:a9ec0cad4f84 119
kishino 22:a9ec0cad4f84 120 /** SNIC_TCP_SEND_FROM_SOCKET_REQ */
kishino 22:a9ec0cad4f84 121 typedef struct
kishino 22:a9ec0cad4f84 122 {
kishino 22:a9ec0cad4f84 123 unsigned char cmd_sid;
kishino 22:a9ec0cad4f84 124 unsigned char seq;
kishino 22:a9ec0cad4f84 125 unsigned char socket_id;
kishino 22:a9ec0cad4f84 126 unsigned char option;
kishino 22:a9ec0cad4f84 127 unsigned char payload_len[2];
kishino 22:a9ec0cad4f84 128 }tagSNIC_TCP_SEND_FROM_SOCKET_REQ_T;
kishino 22:a9ec0cad4f84 129
kishino 22:a9ec0cad4f84 130 /** SNIC_TCP_CONNECT_TO_SERVER_REQ */
kishino 22:a9ec0cad4f84 131 typedef struct
kishino 22:a9ec0cad4f84 132 {
kishino 22:a9ec0cad4f84 133 unsigned char cmd_sid;
kishino 22:a9ec0cad4f84 134 unsigned char seq;
kishino 22:a9ec0cad4f84 135 unsigned char socket_id;
kishino 22:a9ec0cad4f84 136 unsigned char remote_addr[4];
kishino 22:a9ec0cad4f84 137 unsigned char remote_port[2];
kishino 22:a9ec0cad4f84 138 unsigned char recv_bufsize[2];
kishino 22:a9ec0cad4f84 139 unsigned char timeout;
kishino 22:a9ec0cad4f84 140 }tagSNIC_TCP_CONNECT_TO_SERVER_REQ_T;
kishino 22:a9ec0cad4f84 141
kishino 22:a9ec0cad4f84 142 /** WIFI_ON_REQ Command */
kishino 22:a9ec0cad4f84 143 typedef struct
kishino 22:a9ec0cad4f84 144 {
kishino 22:a9ec0cad4f84 145 unsigned char cmd_sid;
kishino 22:a9ec0cad4f84 146 unsigned char seq;
kishino 22:a9ec0cad4f84 147 char country[COUNTRYC_CODE_LENTH];
kishino 22:a9ec0cad4f84 148 }tagWIFI_ON_REQ_T;
kishino 22:a9ec0cad4f84 149
kishino 22:a9ec0cad4f84 150 /** WIFI_OFF_REQ Command */
kishino 22:a9ec0cad4f84 151 typedef struct
kishino 22:a9ec0cad4f84 152 {
kishino 22:a9ec0cad4f84 153 unsigned char cmd_sid;
kishino 22:a9ec0cad4f84 154 unsigned char seq;
kishino 22:a9ec0cad4f84 155 }tagWIFI_OFF_REQ_T;
kishino 22:a9ec0cad4f84 156
kishino 22:a9ec0cad4f84 157 /** WIFI_DISCONNECT_REQ Command */
kishino 22:a9ec0cad4f84 158 typedef struct
kishino 22:a9ec0cad4f84 159 {
kishino 22:a9ec0cad4f84 160 unsigned char cmd_sid;
kishino 22:a9ec0cad4f84 161 unsigned char seq;
kishino 22:a9ec0cad4f84 162 }tagWIFI_DISCONNECT_REQ_T;
kishino 22:a9ec0cad4f84 163
kishino 22:a9ec0cad4f84 164 /** WIFI_GET_STA_RSSI_REQ Command */
kishino 22:a9ec0cad4f84 165 typedef struct
kishino 22:a9ec0cad4f84 166 {
kishino 22:a9ec0cad4f84 167 unsigned char cmd_sid;
kishino 22:a9ec0cad4f84 168 unsigned char seq;
kishino 22:a9ec0cad4f84 169 }tagWIFI_GET_STA_RSSI_REQ_T;
kishino 22:a9ec0cad4f84 170
kishino 22:a9ec0cad4f84 171 /** WIFI_GET_STATUS_REQ Command */
kishino 22:a9ec0cad4f84 172 typedef struct
kishino 22:a9ec0cad4f84 173 {
kishino 22:a9ec0cad4f84 174 unsigned char cmd_sid;
kishino 22:a9ec0cad4f84 175 unsigned char seq;
kishino 22:a9ec0cad4f84 176 unsigned char interface;
kishino 22:a9ec0cad4f84 177 }tagWIFI_GET_STATUS_REQ_T;
kishino 22:a9ec0cad4f84 178
kishino 22:a9ec0cad4f84 179 /** WIFI_SCAN_REQ Command */
kishino 22:a9ec0cad4f84 180 typedef struct
kishino 22:a9ec0cad4f84 181 {
kishino 22:a9ec0cad4f84 182 unsigned char cmd_sid;
kishino 22:a9ec0cad4f84 183 unsigned char seq;
kishino 22:a9ec0cad4f84 184 unsigned char scan_type;
kishino 22:a9ec0cad4f84 185 unsigned char bss_type;
kishino 22:a9ec0cad4f84 186 unsigned char bssid[BSSID_MAC_LENTH];
kishino 22:a9ec0cad4f84 187 unsigned char chan_list;
kishino 22:a9ec0cad4f84 188 unsigned char ssid[SSID_MAX_LENGTH+1];
kishino 22:a9ec0cad4f84 189 }tagWIFI_SCAN_REQ_T;
kishino 22:a9ec0cad4f84 190
kishino 20:dd736d328de6 191
kishino 20:dd736d328de6 192 /** Get buffer for command from memory pool.
kishino 20:dd736d328de6 193 @return Pointer of buffer
kishino 20:dd736d328de6 194 */
kishino 22:a9ec0cad4f84 195 C_SNIC_Core::tagMEMPOOL_BLOCK_T *allocCmdBuf();
kishino 20:dd736d328de6 196
kishino 20:dd736d328de6 197 /** Release buffer to memory pool.
kishino 20:dd736d328de6 198 @param buf_p Pointer of buffer
kishino 20:dd736d328de6 199 */
kishino 20:dd736d328de6 200 void freeCmdBuf( tagMEMPOOL_BLOCK_T *buf_p );
kishino 20:dd736d328de6 201
kishino 20:dd736d328de6 202 /** Initialize UART
kishino 20:dd736d328de6 203 */
kishino 20:dd736d328de6 204 int initUart( PinName tx, PinName rx, int baud );
kishino 20:dd736d328de6 205
kishino 20:dd736d328de6 206 /** Send data to UART
kishino 20:dd736d328de6 207 @param len Length of send data
kishino 20:dd736d328de6 208 @param data Pointer of send data
kishino 20:dd736d328de6 209 @return 0:success/other:fail
kishino 20:dd736d328de6 210 */
kishino 20:dd736d328de6 211 int sendUart( unsigned int len, unsigned char *data );
kishino 20:dd736d328de6 212
kishino 20:dd736d328de6 213 /** Preparation of the UART command
kishino 20:dd736d328de6 214 @param cmd_id UART Command ID
kishino 20:dd736d328de6 215 @param cmd_sid UART Command SubID
kishino 20:dd736d328de6 216 @param req_buf_p Pointer of UART request buffer
kishino 20:dd736d328de6 217 @param req_buf_len Length of UART request buffer
kishino 20:dd736d328de6 218 @param response_buf_p Pointer of UART response buffer
kishino 20:dd736d328de6 219 @param command_p Pointer of UART command[output]
kishino 20:dd736d328de6 220 @return Length of UART command.
kishino 20:dd736d328de6 221 */
kishino 20:dd736d328de6 222 unsigned int preparationSendCommand( unsigned char cmd_id, unsigned char cmd_sid
kishino 20:dd736d328de6 223 , unsigned char *req_buf_p, unsigned int req_buf_len
kishino 20:dd736d328de6 224 , unsigned char *response_buf_p, unsigned char *command_p );
kishino 20:dd736d328de6 225
kishino 20:dd736d328de6 226 /**
kishino 20:dd736d328de6 227 Get pointer of connection information.
kishino 20:dd736d328de6 228 @param socket_id Socket ID
kishino 20:dd736d328de6 229 @return The pointer of connection information
kishino 20:dd736d328de6 230 */
kishino 22:a9ec0cad4f84 231 C_SNIC_Core::tagCONNECT_INFO_T *getConnectInfo( int socket_id );
kishino 20:dd736d328de6 232
kishino 20:dd736d328de6 233 /**
kishino 20:dd736d328de6 234 Get pointer of the instance of C_SNIC_UartCommandManager.
kishino 20:dd736d328de6 235 @return The pointer of the instance of C_SNIC_UartCommandManager.
kishino 20:dd736d328de6 236 */
kishino 20:dd736d328de6 237 C_SNIC_UartCommandManager *getUartCommand();
kishino 20:dd736d328de6 238
kishino 20:dd736d328de6 239 /** Get an instance of the C_SNIC_Core class.
kishino 20:dd736d328de6 240 @return Instance of the C_SNIC_Core class
kishino 20:dd736d328de6 241 @note Please do not create an instance in the default constructor this class.
kishino 20:dd736d328de6 242 Please use this method when you want to get an instance.
kishino 20:dd736d328de6 243 */
kishino 20:dd736d328de6 244 static C_SNIC_Core *getInstance();
kishino 20:dd736d328de6 245
kishino 20:dd736d328de6 246 private:
kishino 20:dd736d328de6 247 static C_SNIC_Core *mInstance_p;
kishino 20:dd736d328de6 248 Thread *mUartRecvThread_p;
kishino 20:dd736d328de6 249 RawSerial *mUart_p;
kishino 20:dd736d328de6 250 Mutex mUartMutex;
kishino 20:dd736d328de6 251 // DigitalInOut mModuleReset;
kishino 20:dd736d328de6 252 C_SNIC_UartCommandManager *mUartCommand_p;
kishino 20:dd736d328de6 253
kishino 20:dd736d328de6 254 /** MemoryPool for payload of UART response */
kishino 20:dd736d328de6 255 MemoryPool<tagMEMPOOL_BLOCK_T, MEMPOOL_PAYLOAD_NUM> mMemPoolPayload;
kishino 20:dd736d328de6 256
kishino 20:dd736d328de6 257 /** Socket buffer */
kishino 20:dd736d328de6 258 tagCONNECT_INFO_T mConnectInfo[MAX_SOCKET_ID+1];
kishino 20:dd736d328de6 259
kishino 20:dd736d328de6 260 /** Constructor
kishino 20:dd736d328de6 261 */
kishino 20:dd736d328de6 262 C_SNIC_Core();
kishino 20:dd736d328de6 263
kishino 20:dd736d328de6 264 /** Receiving thread of UART
kishino 20:dd736d328de6 265 */
kishino 20:dd736d328de6 266 static void uartRecvThread( void const *args_p );
kishino 20:dd736d328de6 267 };
kishino 20:dd736d328de6 268 }
kishino 20:dd736d328de6 269
kishino 20:dd736d328de6 270 #endif