ENEL400 / SerialInterfaceProtocol

simple serial protocol

Dependents:   AwsomeStation LoRaBaseStation LoRaTerminal

SerialInterfaceProtocol.cpp@9:61ed835bb206, 2016-08-24 (annotated)

Committer:
rba90
Date:
Wed Aug 24 09:42:30 2016 +0000
Revision:
9:61ed835bb206
Parent:
8:9a8085508415
Child:
10:2a710d0bab2c
fix a bug where memory access violation would occur

Who changed what in which revision?

UserRevisionLine numberNew contents of line
rba90 0:21e4e3afa5e6 1 #include "SerialInterfaceProtocol.h"
rba90 1:03208c983c8b 2 #include "mbed.h"
rba90 0:21e4e3afa5e6 3
rba90 0:21e4e3afa5e6 4 SerialInterfaceProtocol::SerialInterfaceProtocol(SerialBuffer_t *in, SerialBuffer_t *out)
rba90 0:21e4e3afa5e6 5 {
rba90 0:21e4e3afa5e6 6 // assign input and output buffers
rba90 0:21e4e3afa5e6 7 SerialInputBuffer = in;
rba90 0:21e4e3afa5e6 8 SerialOutputBuffer = out;
rba90 0:21e4e3afa5e6 9
rba90 0:21e4e3afa5e6 10 // init command vector table
rba90 0:21e4e3afa5e6 11 for (int i = 0; i < SIP_CMD_VECTOR_TABLE_SZ; i++)
rba90 0:21e4e3afa5e6 12 {
rba90 0:21e4e3afa5e6 13 CommandVectorTable[i] = NULL;
rba90 0:21e4e3afa5e6 14 }
rba90 0:21e4e3afa5e6 15
rba90 0:21e4e3afa5e6 16 // init internal state machine
rba90 0:21e4e3afa5e6 17 state = CommandPacket::NONE;
rba90 0:21e4e3afa5e6 18
rba90 0:21e4e3afa5e6 19 // init internal state
rba90 3:22bb958f0eb0 20 isChecksumEnabled = false;
rba90 0:21e4e3afa5e6 21 }
rba90 0:21e4e3afa5e6 22
rba90 0:21e4e3afa5e6 23 SerialInterfaceProtocol::~SerialInterfaceProtocol()
rba90 0:21e4e3afa5e6 24 {
rba90 0:21e4e3afa5e6 25
rba90 0:21e4e3afa5e6 26 }
rba90 0:21e4e3afa5e6 27
rba90 0:21e4e3afa5e6 28 void SerialInterfaceProtocol::registerCommand(uint8_t command, callback_func f)
rba90 0:21e4e3afa5e6 29 {
rba90 0:21e4e3afa5e6 30 CommandVectorTable[command] = f;
rba90 0:21e4e3afa5e6 31 }
rba90 0:21e4e3afa5e6 32
rba90 0:21e4e3afa5e6 33 void SerialInterfaceProtocol::deRegisterCommand(uint8_t command)
rba90 0:21e4e3afa5e6 34 {
rba90 0:21e4e3afa5e6 35 CommandVectorTable[command] = NULL;
rba90 0:21e4e3afa5e6 36 }
rba90 0:21e4e3afa5e6 37
rba90 0:21e4e3afa5e6 38 int SerialInterfaceProtocol::execute(uint8_t *response, uint8_t *response_length)
rba90 0:21e4e3afa5e6 39 {
rba90 0:21e4e3afa5e6 40
rba90 0:21e4e3afa5e6 41 // execute the command if it's already been registered
rba90 0:21e4e3afa5e6 42 if (CommandVectorTable[PacketBuffer.command] != NULL)
rba90 0:21e4e3afa5e6 43 {
rba90 0:21e4e3afa5e6 44 return CommandVectorTable[PacketBuffer.command](
rba90 0:21e4e3afa5e6 45 PacketBuffer.payload,
rba90 0:21e4e3afa5e6 46 PacketBuffer.length,
rba90 0:21e4e3afa5e6 47 response,
rba90 0:21e4e3afa5e6 48 response_length
rba90 0:21e4e3afa5e6 49 );
rba90 0:21e4e3afa5e6 50 }
rba90 0:21e4e3afa5e6 51
rba90 0:21e4e3afa5e6 52 return -1;
rba90 0:21e4e3afa5e6 53 }
rba90 0:21e4e3afa5e6 54
rba90 0:21e4e3afa5e6 55 int SerialInterfaceProtocol::assemble(uint8_t *response, uint8_t response_length)
rba90 0:21e4e3afa5e6 56 {
rba90 0:21e4e3afa5e6 57 // prepare for packet buffer
rba90 0:21e4e3afa5e6 58 PacketBuffer.sflag = CommandPacket::CP_SFLAG;
rba90 0:21e4e3afa5e6 59
rba90 5:d39ee3fc4f4a 60 // if no response, return E, otherwise return F
rba90 5:d39ee3fc4f4a 61 if (response_length != 0)
rba90 5:d39ee3fc4f4a 62 {
rba90 5:d39ee3fc4f4a 63 PacketBuffer.command = 0xF0 | ((uint8_t) PacketBuffer.errno & 0x0f);
rba90 5:d39ee3fc4f4a 64 }
rba90 5:d39ee3fc4f4a 65 else
rba90 5:d39ee3fc4f4a 66 {
rba90 5:d39ee3fc4f4a 67 PacketBuffer.command = 0xE0 | ((uint8_t) PacketBuffer.errno & 0x0f);
rba90 5:d39ee3fc4f4a 68 }
rba90 5:d39ee3fc4f4a 69
rba90 5:d39ee3fc4f4a 70 // reserve one byte for user command
rba90 5:d39ee3fc4f4a 71 PacketBuffer.length = response_length;
rba90 0:21e4e3afa5e6 72
rba90 5:d39ee3fc4f4a 73 // copy buffer to payload
rba90 0:21e4e3afa5e6 74 memcpy(PacketBuffer.payload, response, response_length);
rba90 0:21e4e3afa5e6 75
rba90 5:d39ee3fc4f4a 76 // generate checksum
rba90 0:21e4e3afa5e6 77 PacketBuffer.checksum = PacketBuffer.generate_checksum();
rba90 0:21e4e3afa5e6 78
rba90 0:21e4e3afa5e6 79 PacketBuffer.eflag = CommandPacket::CP_EFLAG;
rba90 0:21e4e3afa5e6 80
rba90 0:21e4e3afa5e6 81 // serialize the packet
rba90 9:61ed835bb206 82 int total_len = PacketBuffer.length * 2 + 9;
rba90 0:21e4e3afa5e6 83 uint8_t buffer[total_len];
rba90 0:21e4e3afa5e6 84 memset(buffer, 0x0, total_len);
rba90 0:21e4e3afa5e6 85
rba90 0:21e4e3afa5e6 86 PacketBuffer.serialize(buffer);
rba90 1:03208c983c8b 87
rba90 0:21e4e3afa5e6 88 // add to ring buffer
rba90 0:21e4e3afa5e6 89 for (int i = 0; i < total_len; i++)
rba90 0:21e4e3afa5e6 90 {
rba90 0:21e4e3afa5e6 91 SerialOutputBuffer->enqueue(buffer[i]);
rba90 0:21e4e3afa5e6 92 }
rba90 0:21e4e3afa5e6 93
rba90 7:100865963801 94 return 0;
rba90 7:100865963801 95 }
rba90 7:100865963801 96
rba90 7:100865963801 97 int SerialInterfaceProtocol::respond(uint8_t command, uint8_t *response, uint8_t response_length)
rba90 7:100865963801 98 {
rba90 7:100865963801 99 // prepare for packet buffer
rba90 7:100865963801 100 PacketBuffer.sflag = CommandPacket::CP_SFLAG;
rba90 7:100865963801 101
rba90 7:100865963801 102 // return flag as specified by the user
rba90 7:100865963801 103 PacketBuffer.command = command;
rba90 7:100865963801 104
rba90 7:100865963801 105 // copy buffer length
rba90 7:100865963801 106 PacketBuffer.length = response_length;
rba90 7:100865963801 107
rba90 7:100865963801 108 // copy buffer to payload
rba90 7:100865963801 109 memcpy(PacketBuffer.payload, response, response_length);
rba90 7:100865963801 110
rba90 7:100865963801 111 // generate checksum
rba90 7:100865963801 112 PacketBuffer.checksum = PacketBuffer.generate_checksum();
rba90 0:21e4e3afa5e6 113
rba90 7:100865963801 114 // end flag
rba90 7:100865963801 115 PacketBuffer.eflag = CommandPacket::CP_EFLAG;
rba90 7:100865963801 116
rba90 7:100865963801 117 // serialize the packet
rba90 9:61ed835bb206 118 int total_len = PacketBuffer.length * 2 + 9;
rba90 7:100865963801 119 uint8_t buffer[total_len];
rba90 7:100865963801 120 memset(buffer, 0x0, total_len);
rba90 7:100865963801 121
rba90 7:100865963801 122 PacketBuffer.serialize(buffer);
rba90 7:100865963801 123
rba90 7:100865963801 124 // add to ring buffer
rba90 7:100865963801 125 for (int i = 0; i < total_len; i++)
rba90 7:100865963801 126 {
rba90 7:100865963801 127 SerialOutputBuffer->enqueue(buffer[i]);
rba90 7:100865963801 128 }
rba90 7:100865963801 129
rba90 7:100865963801 130 return 0;
rba90 7:100865963801 131 };
rba90 7:100865963801 132
rba90 0:21e4e3afa5e6 133
rba90 0:21e4e3afa5e6 134 void SerialInterfaceProtocol::poll()
rba90 0:21e4e3afa5e6 135 {
rba90 0:21e4e3afa5e6 136 static uint8_t payload_counter = 0;
rba90 0:21e4e3afa5e6 137 uint8_t response[SIP_MAX_RESP_LEN];
rba90 0:21e4e3afa5e6 138 uint8_t response_length;
rba90 0:21e4e3afa5e6 139
rba90 0:21e4e3afa5e6 140 // fetch data from ring buffer
rba90 0:21e4e3afa5e6 141 while (SerialInputBuffer->getCounter() > 0)
rba90 0:21e4e3afa5e6 142 {
rba90 0:21e4e3afa5e6 143 uint8_t ch;
rba90 0:21e4e3afa5e6 144 ch = SerialInputBuffer->dequeue();
rba90 0:21e4e3afa5e6 145
rba90 0:21e4e3afa5e6 146 // reset state to keep sync
rba90 0:21e4e3afa5e6 147 if (ch == CommandPacket::CP_SFLAG)
rba90 0:21e4e3afa5e6 148 {
rba90 0:21e4e3afa5e6 149 state = CommandPacket::SFLAG;
rba90 0:21e4e3afa5e6 150
rba90 0:21e4e3afa5e6 151 // reset variable
rba90 0:21e4e3afa5e6 152 payload_counter = 0;
rba90 0:21e4e3afa5e6 153 memset(PacketBuffer.payload, 0x0, sizeof(PacketBuffer.payload));
rba90 0:21e4e3afa5e6 154 PacketBuffer.errno = CommandPacket::NO_ERROR;
rba90 0:21e4e3afa5e6 155 }
rba90 0:21e4e3afa5e6 156
rba90 0:21e4e3afa5e6 157 switch (state)
rba90 0:21e4e3afa5e6 158 {
rba90 0:21e4e3afa5e6 159 case CommandPacket::SFLAG:
rba90 0:21e4e3afa5e6 160 PacketBuffer.sflag = ch;
rba90 0:21e4e3afa5e6 161 state = CommandPacket::COMMAND_H;
rba90 8:9a8085508415 162 #ifdef DEBUG_SIP
rba90 0:21e4e3afa5e6 163 printf("CommandPacket::SFLAG: 0x%x\r\n", PacketBuffer.sflag);
rba90 0:21e4e3afa5e6 164 #endif
rba90 0:21e4e3afa5e6 165 break;
rba90 0:21e4e3afa5e6 166
rba90 0:21e4e3afa5e6 167 case CommandPacket::COMMAND_H:
rba90 0:21e4e3afa5e6 168 PacketBuffer.command = hexchar_to_uint8(ch) << 4;
rba90 0:21e4e3afa5e6 169 state = CommandPacket::COMMAND_L;
rba90 8:9a8085508415 170 #ifdef DEBUG_SIP
rba90 0:21e4e3afa5e6 171 printf("CommandPacket::COMMAND_H: 0x%x\r\n", PacketBuffer.command);
rba90 0:21e4e3afa5e6 172 #endif
rba90 0:21e4e3afa5e6 173 break;
rba90 0:21e4e3afa5e6 174
rba90 0:21e4e3afa5e6 175 case CommandPacket::COMMAND_L:
rba90 0:21e4e3afa5e6 176 PacketBuffer.command |= (hexchar_to_uint8(ch) & 0x0f);
rba90 0:21e4e3afa5e6 177 state = CommandPacket::LENGTH_H;
rba90 8:9a8085508415 178 #ifdef DEBUG_SIP
rba90 0:21e4e3afa5e6 179 printf("CommandPacket::COMMAND_L: 0x%x\r\n", PacketBuffer.command);
rba90 0:21e4e3afa5e6 180 #endif
rba90 0:21e4e3afa5e6 181 break;
rba90 0:21e4e3afa5e6 182
rba90 0:21e4e3afa5e6 183 case CommandPacket::LENGTH_H:
rba90 0:21e4e3afa5e6 184 PacketBuffer.length = hexchar_to_uint8(ch) << 4;
rba90 0:21e4e3afa5e6 185 state = CommandPacket::LENGTH_L;
rba90 8:9a8085508415 186 #ifdef DEBUG_SIP
rba90 0:21e4e3afa5e6 187 printf("CommandPacket::LENGTH_H: 0x%x\r\n", PacketBuffer.length);
rba90 0:21e4e3afa5e6 188 #endif
rba90 0:21e4e3afa5e6 189 break;
rba90 0:21e4e3afa5e6 190
rba90 0:21e4e3afa5e6 191 case CommandPacket::LENGTH_L:
rba90 0:21e4e3afa5e6 192 PacketBuffer.length |= (hexchar_to_uint8(ch) & 0x0f);
rba90 0:21e4e3afa5e6 193 if (PacketBuffer.length != 0) // if the length is not zero, then proceed to payload state
rba90 0:21e4e3afa5e6 194 {
rba90 0:21e4e3afa5e6 195 state = CommandPacket::PAYLOAD_H;
rba90 0:21e4e3afa5e6 196 }
rba90 0:21e4e3afa5e6 197 else // otherwise proceed to checksum state
rba90 0:21e4e3afa5e6 198 {
rba90 0:21e4e3afa5e6 199 state = CommandPacket::CHECKSUM_H;
rba90 0:21e4e3afa5e6 200 }
rba90 8:9a8085508415 201 #ifdef DEBUG_SIP
rba90 0:21e4e3afa5e6 202 printf("CommandPacket::LENGTH_L: 0x%x\r\n", PacketBuffer.length);
rba90 0:21e4e3afa5e6 203 #endif
rba90 0:21e4e3afa5e6 204 break;
rba90 0:21e4e3afa5e6 205
rba90 0:21e4e3afa5e6 206 case CommandPacket::PAYLOAD_H:
rba90 0:21e4e3afa5e6 207 PacketBuffer.payload[payload_counter] = hexchar_to_uint8(ch) << 4; // store higher 4 bits of payload
rba90 0:21e4e3afa5e6 208 state = CommandPacket::PAYLOAD_L;
rba90 8:9a8085508415 209 #ifdef DEBUG_SIP
rba90 0:21e4e3afa5e6 210 printf("CommandPacket::PAYLOAD_H: 0x%x\r\n", PacketBuffer.payload[payload_counter]);
rba90 0:21e4e3afa5e6 211 #endif
rba90 0:21e4e3afa5e6 212 break;
rba90 0:21e4e3afa5e6 213
rba90 0:21e4e3afa5e6 214 case CommandPacket::PAYLOAD_L:
rba90 0:21e4e3afa5e6 215 PacketBuffer.payload[payload_counter++] |= (hexchar_to_uint8(ch) & 0x0f); // store lower 4 bits of payload
rba90 0:21e4e3afa5e6 216 if (payload_counter < PacketBuffer.length) // append ch to payload until reach the length
rba90 0:21e4e3afa5e6 217 {
rba90 0:21e4e3afa5e6 218 state = CommandPacket::PAYLOAD_H;
rba90 0:21e4e3afa5e6 219 }
rba90 0:21e4e3afa5e6 220 else
rba90 0:21e4e3afa5e6 221 {
rba90 0:21e4e3afa5e6 222 state = CommandPacket::CHECKSUM_H;
rba90 0:21e4e3afa5e6 223 }
rba90 8:9a8085508415 224 #ifdef DEBUG_SIP
rba90 0:21e4e3afa5e6 225 printf("CommandPacket::PAYLOAD_L: 0x%x\r\n", PacketBuffer.payload[payload_counter - 1]);
rba90 0:21e4e3afa5e6 226 #endif
rba90 0:21e4e3afa5e6 227 break;
rba90 0:21e4e3afa5e6 228
rba90 0:21e4e3afa5e6 229 case CommandPacket::CHECKSUM_H:
rba90 0:21e4e3afa5e6 230 PacketBuffer.checksum = hexchar_to_uint8(ch) << 4;
rba90 0:21e4e3afa5e6 231 state = CommandPacket::CHECKSUM_L;
rba90 8:9a8085508415 232 #ifdef DEBUG_SIP
rba90 0:21e4e3afa5e6 233 printf("CommandPacket::CHECKSUM_H: 0x%x\r\n", PacketBuffer.checksum);
rba90 0:21e4e3afa5e6 234 #endif
rba90 0:21e4e3afa5e6 235 break;
rba90 0:21e4e3afa5e6 236
rba90 0:21e4e3afa5e6 237 case CommandPacket::CHECKSUM_L:
rba90 0:21e4e3afa5e6 238 PacketBuffer.checksum |= (hexchar_to_uint8(ch) & 0x0f);
rba90 0:21e4e3afa5e6 239
rba90 0:21e4e3afa5e6 240 // checksum can be turned off
rba90 0:21e4e3afa5e6 241 if (isChecksumEnabled)
rba90 0:21e4e3afa5e6 242 {
rba90 0:21e4e3afa5e6 243 if (PacketBuffer.verify()) // checksum match
rba90 0:21e4e3afa5e6 244 {
rba90 0:21e4e3afa5e6 245 state = CommandPacket::EFLAG;
rba90 0:21e4e3afa5e6 246 }
rba90 0:21e4e3afa5e6 247 else // checksum mismatch
rba90 0:21e4e3afa5e6 248 {
rba90 1:03208c983c8b 249 // clear response and response length
rba90 1:03208c983c8b 250 response_length = 0;
rba90 1:03208c983c8b 251 memset(response, 0x0, sizeof(response));
rba90 0:21e4e3afa5e6 252
rba90 0:21e4e3afa5e6 253 // prepare for checksum error response
rba90 0:21e4e3afa5e6 254 PacketBuffer.errno = CommandPacket::INVALID_CS_ERROR;
rba90 0:21e4e3afa5e6 255 assemble(response, response_length);
rba90 0:21e4e3afa5e6 256
rba90 0:21e4e3afa5e6 257 state = CommandPacket::NONE;
rba90 0:21e4e3afa5e6 258 }
rba90 0:21e4e3afa5e6 259 }
rba90 0:21e4e3afa5e6 260 else
rba90 0:21e4e3afa5e6 261 {
rba90 0:21e4e3afa5e6 262 state = CommandPacket::EFLAG;
rba90 0:21e4e3afa5e6 263 }
rba90 0:21e4e3afa5e6 264
rba90 0:21e4e3afa5e6 265
rba90 8:9a8085508415 266 #ifdef DEBUG_SIP
rba90 0:21e4e3afa5e6 267 printf("CommandPacket::CHECKSUM_L: 0x%x\r\n", PacketBuffer.checksum);
rba90 0:21e4e3afa5e6 268 #endif
rba90 0:21e4e3afa5e6 269 break;
rba90 0:21e4e3afa5e6 270
rba90 0:21e4e3afa5e6 271 case CommandPacket::EFLAG:
rba90 0:21e4e3afa5e6 272 if (ch == CommandPacket::CP_EFLAG)
rba90 0:21e4e3afa5e6 273 {
rba90 0:21e4e3afa5e6 274 PacketBuffer.eflag = ch;
rba90 0:21e4e3afa5e6 275
rba90 0:21e4e3afa5e6 276 // clear response and response length
rba90 0:21e4e3afa5e6 277 response_length = 0;
rba90 0:21e4e3afa5e6 278 memset(response, 0x0, sizeof(response));
rba90 0:21e4e3afa5e6 279
rba90 0:21e4e3afa5e6 280 // execute command
rba90 0:21e4e3afa5e6 281 int ret = execute(response, &response_length);
rba90 0:21e4e3afa5e6 282
rba90 0:21e4e3afa5e6 283 if (ret < 0) // command not registered
rba90 0:21e4e3afa5e6 284 {
rba90 0:21e4e3afa5e6 285 PacketBuffer.errno = CommandPacket::INVALID_CMD_ERROR;
rba90 0:21e4e3afa5e6 286 }
rba90 0:21e4e3afa5e6 287 else if (ret != 0) // error to execute
rba90 0:21e4e3afa5e6 288 {
rba90 0:21e4e3afa5e6 289 PacketBuffer.errno = CommandPacket::INVALID_EXEC_ERROR;
rba90 0:21e4e3afa5e6 290 }
rba90 4:4a92da3f19c0 291 else
rba90 4:4a92da3f19c0 292 {
rba90 4:4a92da3f19c0 293 PacketBuffer.errno = CommandPacket::NO_ERROR;
rba90 4:4a92da3f19c0 294 }
rba90 0:21e4e3afa5e6 295
rba90 0:21e4e3afa5e6 296 assemble(response, response_length);
rba90 0:21e4e3afa5e6 297 }
rba90 0:21e4e3afa5e6 298 state = CommandPacket::NONE;
rba90 8:9a8085508415 299 #ifdef DEBUG_SIP
rba90 0:21e4e3afa5e6 300 printf("CommandPacket::EFLAG: 0x%x\r\n", PacketBuffer.eflag);
rba90 0:21e4e3afa5e6 301 #endif
rba90 0:21e4e3afa5e6 302 break;
rba90 0:21e4e3afa5e6 303
rba90 0:21e4e3afa5e6 304 case CommandPacket::NONE:
rba90 1:03208c983c8b 305 // clear response and response length
rba90 1:03208c983c8b 306 response_length = 0;
rba90 1:03208c983c8b 307 memset(response, 0x0, sizeof(response));
rba90 0:21e4e3afa5e6 308
rba90 1:03208c983c8b 309 // Execute error generator
rba90 0:21e4e3afa5e6 310 PacketBuffer.errno = CommandPacket::INVALID_SFLAG_ERROR;
rba90 0:21e4e3afa5e6 311 assemble(response, response_length);
rba90 0:21e4e3afa5e6 312
rba90 8:9a8085508415 313 #ifdef DEBUG_SIP
rba90 0:21e4e3afa5e6 314 printf("CommandPacket::NONE\r\n");
rba90 0:21e4e3afa5e6 315 #endif
rba90 0:21e4e3afa5e6 316 break;
rba90 0:21e4e3afa5e6 317
rba90 0:21e4e3afa5e6 318 default:
rba90 0:21e4e3afa5e6 319 break;
rba90 0:21e4e3afa5e6 320 }
rba90 0:21e4e3afa5e6 321 }
rba90 0:21e4e3afa5e6 322 }
rba90 0:21e4e3afa5e6 323
rba90 0:21e4e3afa5e6 324 void SerialInterfaceProtocol::disableChecksum()
rba90 0:21e4e3afa5e6 325 {
rba90 0:21e4e3afa5e6 326 isChecksumEnabled = false;
rba90 0:21e4e3afa5e6 327 }
rba90 0:21e4e3afa5e6 328
rba90 0:21e4e3afa5e6 329 void SerialInterfaceProtocol::enableChecksum()
rba90 0:21e4e3afa5e6 330 {
rba90 0:21e4e3afa5e6 331 isChecksumEnabled = true;
rba90 0:21e4e3afa5e6 332 }