muRata / SNICInterface

SNIC UART　Interface library: Serial to Wi-Fi library for Murata TypeYD Wi-Fi module. For more information about TypeYD: http://www.murata.co.jp/products/microwave/module/lbwb1zzydz/index.html

Dependents:   SNIC-xively-jumpstart-demo SNIC-FluentLogger-example TCPEchoServer murataDemo ... more

Fork of YDwifiInterface by Takao Kishino

SNIC/SNIC_Core.h@29:6a0ba999597d, 2014-05-26 (annotated)

Committer:
kishino
Date:
Mon May 26 05:17:28 2014 +0000
Revision:
29:6a0ba999597d
Parent:
28:b796031f6519
Child:
31:15c22824cc46
Changed the receive logic of UART.; Changed the use area of the global buffer.

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