VZTECH / Mbed 2 deprecated main_src

Modularizando o src

Dependencies:   EALib EthernetInterface_vz mbed-rtos mbed

Fork of header_main_colinas_V0-20-09-14 by VZTECH

vz_protocol.h@121:ee02790d00b7, 2015-05-08 (annotated)

Committer:
klauss
Date:
Fri May 08 04:15:23 2015 +0000
Revision:
121:ee02790d00b7
Parent:
119:ee6a53069455
Child:
122:480c44b0e205
compiling

Who changed what in which revision?

UserRevisionLine numberNew contents of line
klauss 69:65665afbad5d 1 /**
klauss 69:65665afbad5d 2 * @file vz_protocol.h
klauss 69:65665afbad5d 3 * @Synopsis Implementa as principais funcionalidades do protocolo de comunicação entre os CBx -> Header e Header -> CBx.
klauss 69:65665afbad5d 4 * @author Jhonatan Casale
klauss 69:65665afbad5d 5 * @version 1
klauss 69:65665afbad5d 6 * @date 2014-11-05
klauss 69:65665afbad5d 7 */
klauss 69:65665afbad5d 8
klauss 74:81c47fff88a5 9 #ifndef __VZ_PROTOCOL_H__
klauss 74:81c47fff88a5 10 #define __VZ_PROTOCOL_H__
klauss 0:4d17cd9c8f9d 11
klauss 121:ee02790d00b7 12 #include "EthernetInterface.h"
klauss 121:ee02790d00b7 13 #include "mbed.h"
klauss 121:ee02790d00b7 14 #include <string.h>
klauss 0:4d17cd9c8f9d 15 #include <stdlib.h>
klauss 0:4d17cd9c8f9d 16 #include <stdint.h>
klauss 121:ee02790d00b7 17 #include "debug.h"
klauss 0:4d17cd9c8f9d 18 #include "bits.h"
klauss 119:ee6a53069455 19 #include "clock.h"
klauss 121:ee02790d00b7 20 #include "utils.h"
klauss 0:4d17cd9c8f9d 21
klauss 119:ee6a53069455 22 const uint16_t SHIFT_PORT = 3000;
klauss 121:ee02790d00b7 23 ///< Deslocamento padrão de porta, usado na forma <ext recebido + SHIFT_PORT>
klauss 119:ee6a53069455 24
klauss 119:ee6a53069455 25 const uint8_t MIN_EXT = 1;
klauss 121:ee02790d00b7 26 ///< Define o valor minimo de ramal que sera processado.
klauss 121:ee02790d00b7 27
klauss 81:3656f00ab3db 28 extern int begin;
klauss 121:ee02790d00b7 29 ///< Registra o numero do menor ramal conhecido pela header até o momento
klauss 81:3656f00ab3db 30
klauss 119:ee6a53069455 31 const uint16_t MAX_EXT = 5999;
klauss 121:ee02790d00b7 32 ///< Define o valor máximo de ramal que sera processado.
klauss 79:9bc12aa305a9 33
klauss 121:ee02790d00b7 34 extern int end;
klauss 121:ee02790d00b7 35 ///< Registra o numero do maior ramal conhecido pela header até o momento
klauss 36:728498a78e1e 36
klauss 119:ee6a53069455 37 const uint8_t VZ_HEADER_OFFSET = 7;
klauss 69:65665afbad5d 38 ///< Indica o inicio dos dados recebidos efetivamente no pacote VZ.
klauss 121:ee02790d00b7 39
klauss 119:ee6a53069455 40 const uint8_t CLOCK_SYNC_SIZE = 14;
klauss 69:65665afbad5d 41 ///< Indica o numero de bytes ocupados pelo relogio no pacote transmitido.
klauss 121:ee02790d00b7 42
klauss 119:ee6a53069455 43 const uint8_t SEQ_NUM_SIZE = 1;
klauss 69:65665afbad5d 44 ///< Indica o numero de bytes ocupados para uso de sequence number.
klauss 121:ee02790d00b7 45
klauss 119:ee6a53069455 46 const uint8_t CB_AUDIO_DATA_SIZE = 240;
klauss 69:65665afbad5d 47 ///< Indica o numero de pacotes enviados pelo CBx referente a dados de audio.
klauss 121:ee02790d00b7 48
klauss 119:ee6a53069455 49 const uint8_t TIMESLICE_PLACE = 22;
klauss 69:65665afbad5d 50 ///< Indica o local ( em relação ao começo do pacote ) onde se encontra o timeslice.
klauss 0:4d17cd9c8f9d 51
klauss 119:ee6a53069455 52 const uint16_t BASE_PORT = 5000;
klauss 119:ee6a53069455 53 ///< Estabelece o menor ramal aceito para tratamento
klauss 119:ee6a53069455 54
klauss 119:ee6a53069455 55 const uint8_t MAX_CB_IN_A_BRANCH = 52;
klauss 78:1353744f01e1 56 ///< Estabelece o nro máximo de CBx em um mesmo ramo
klauss 69:65665afbad5d 57
klauss 119:ee6a53069455 58 const uint8_t BOOT = 0x00;
klauss 69:65665afbad5d 59 ///< Indica o tipo boot, enviado pelo CBx, assim que o mesmo liga ou sofre reboot.
klauss 100:09a23fcd3bdf 60
klauss 119:ee6a53069455 61 const uint8_t REGISTRY = 0x02;
klauss 69:65665afbad5d 62 ///< Tipo de registro, enviado pelo CBx, quando o mesmo quer se registrar, enviado pela Header para verificar se determinado CBx ainda esta ativo.
klauss 121:ee02790d00b7 63
klauss 119:ee6a53069455 64 const uint8_t REGISTRY_ACK = 0x02 | BIT7;
klauss 121:ee02790d00b7 65 ///< "ack de resposta" do tiop REGISTRY
klauss 100:09a23fcd3bdf 66
klauss 119:ee6a53069455 67 const uint8_t INVITE = 0x04;
klauss 69:65665afbad5d 68 ///< Representa o tipo de pedido de invite, enviado pelo CBx sempre quando o mesmo quer iniciar uma ligação com o server.
klauss 121:ee02790d00b7 69
klauss 119:ee6a53069455 70 const uint8_t INVITE_ACK = 0x04 | BIT7;
klauss 121:ee02790d00b7 71 ///< "ack de resposta" do tiop INVITE
klauss 100:09a23fcd3bdf 72
klauss 119:ee6a53069455 73 const uint8_t AUDIO = 0x08;
klauss 69:65665afbad5d 74 ///< Pacotes do tipo audio são trocados entre Header e CBx durante a ligação, representam os dados RTP.
klauss 119:ee6a53069455 75
klauss 119:ee6a53069455 76 const uint8_t TELEMETRY = 0x10;
klauss 69:65665afbad5d 77 ///< Define o tipo de pacote de telemetria enviado pelo CBx.
klauss 119:ee6a53069455 78
klauss 119:ee6a53069455 79 const uint8_t BOOTLOADER_CBX = 0x03;
klauss 114:472502b31a12 80 ///< Define o tipo de pacote para a gravação do CBx
klauss 119:ee6a53069455 81
klauss 119:ee6a53069455 82 const uint8_t CB_BYE = 0x20;
klauss 69:65665afbad5d 83 ///< Representa o tipo de pacote que o CBx envia para a Header solicitando o final da ligação.
klauss 121:ee02790d00b7 84
klauss 119:ee6a53069455 85 const uint8_t CB_BYE_ACK = 0x20 | BIT7;
klauss 121:ee02790d00b7 86 ///< "ack de resposta" do tiop CB_BYE
klauss 119:ee6a53069455 87
klauss 119:ee6a53069455 88 const uint8_t PROMPT = 0x01;
klauss 69:65665afbad5d 89 ///< Identifica o tipo de pacote responsavel por mandar comandos executáveis no Cbx.
klauss 119:ee6a53069455 90
klauss 119:ee6a53069455 91 const uint8_t FLOOD = 0x40;
klauss 69:65665afbad5d 92 ///< Representa os pacotes de flood, úteis para validação de comunicação Header-CBx.
klauss 119:ee6a53069455 93
klauss 119:ee6a53069455 94 const uint8_t FW = 0x50;
klauss 99:e80850c51106 95 ///< Tipo para redirecionamento semn tratamento para uma determinada porta UDP pré-configurada.
klauss 121:ee02790d00b7 96
klauss 119:ee6a53069455 97 const uint8_t FW1 = 0x51;
klauss 99:e80850c51106 98 ///< Tipo para redirecionamento semn tratamento para uma determinada porta UDP pré-configurada.
klauss 121:ee02790d00b7 99
klauss 119:ee6a53069455 100 const uint8_t FW2 = 0x52;
klauss 119:ee6a53069455 101 ///< Tipo para redirecionamento semn tratamento para uma determinada porta UDP pré-configurada.
klauss 121:ee02790d00b7 102
klauss 119:ee6a53069455 103 const uint8_t FW3 = 0x53;
klauss 99:e80850c51106 104 ///< Tipo para redirecionamento semn tratamento para uma determinada porta UDP pré-configurada.
klauss 121:ee02790d00b7 105
klauss 119:ee6a53069455 106 const uint8_t FW4 = 0x54;
klauss 99:e80850c51106 107 ///< Tipo para redirecionamento semn tratamento para uma determinada porta UDP pré-configurada.
klauss 121:ee02790d00b7 108
klauss 119:ee6a53069455 109 const uint8_t FW5 = 0x55;
klauss 99:e80850c51106 110 ///< Tipo para redirecionamento semn tratamento para uma determinada porta UDP pré-configurada.
klauss 121:ee02790d00b7 111
klauss 119:ee6a53069455 112 const uint8_t FW6 = 0x56;
klauss 99:e80850c51106 113 ///< Tipo para redirecionamento semn tratamento para uma determinada porta UDP pré-configurada.
klauss 99:e80850c51106 114
klauss 119:ee6a53069455 115 const uint8_t CB_STATS = 0x07;
klauss 121:ee02790d00b7 116 ///< Tipo de comunicação de estatisticas de rede, enviadas pela CBx
klauss 121:ee02790d00b7 117
klauss 119:ee6a53069455 118 const uint8_t CB_STATS_ACK = 0x07 | BIT7;
klauss 121:ee02790d00b7 119 ///< "ack de resposta" do tiop CB_STATS_ACK
klauss 121:ee02790d00b7 120
klauss 121:ee02790d00b7 121 const uint16_t BROADCAST_EXT = 0x03f2;
klauss 121:ee02790d00b7 122 ///< Ramal de broadcast, usado na comunicação Header -> CBx
klauss 99:e80850c51106 123
klauss 119:ee6a53069455 124 const uint8_t DO_NOTHING = 0x7f;
klauss 69:65665afbad5d 125 ///< Representa o tipo de idle, importante para algumas comunicações.
klauss 0:4d17cd9c8f9d 126
klauss 119:ee6a53069455 127 const char MY_IP[] = "192.168.120.171";
klauss 69:65665afbad5d 128 ///< Representa o IP default da Header.
klauss 119:ee6a53069455 129 //#define __MY_IP__ "192.168.2.20?" // Colinas
klauss 119:ee6a53069455 130 //#define __MY_IP__ "192.168.1.200" // Colinas
klauss 119:ee6a53069455 131
klauss 119:ee6a53069455 132 const uint16_t MY_EXT = 820;
klauss 69:65665afbad5d 133 ///< Indica o ramal default da Header.
klauss 119:ee6a53069455 134
klauss 119:ee6a53069455 135 const uint16_t MY_PORT = 5062;
klauss 69:65665afbad5d 136 ///< Representa a porta default da Header.
klauss 28:94aec56c6329 137
klauss 119:ee6a53069455 138 const char SERVER_IP[] = "192.168.120.120";
klauss 69:65665afbad5d 139 ///< Indica o IP defaut do servidor para onde a Header ira encaminhar pedidos de ligação.
klauss 119:ee6a53069455 140 //#define __SERVER_IP__ "192.168.30.25" // Colinas
klauss 29:7246460b73f8 141
klauss 119:ee6a53069455 142 const uint16_t PEER_EXT = 913;
klauss 119:ee6a53069455 143 ///< Estabelece o ramal default para onde a Header ira direcionar os pedidos de ligações.
klauss 119:ee6a53069455 144 //#define __PEER_EXT__ 812 // VZ Producao
klauss 119:ee6a53069455 145 //#define __PEER_EXT__ 813 // VZ Desenvolvimento
klauss 69:65665afbad5d 146
klauss 119:ee6a53069455 147 const uint16_t SERVER_PORT = 5075;
klauss 69:65665afbad5d 148 ///< Indica a porta default do server para onde os pacotes eth serão enviados na negociação SIP.
klauss 119:ee6a53069455 149 //#define __SERVER_PORT__ 5060 // Colinas
klauss 28:94aec56c6329 150
klauss 119:ee6a53069455 151 const char MY_MSK[] = "255.255.255.0";
klauss 69:65665afbad5d 152 ///< Indica a mascara de rede onde a Header se encontra.
klauss 119:ee6a53069455 153 //#define __MY_GTW__ "192.168.2.254" // Colinas
klauss 119:ee6a53069455 154
klauss 119:ee6a53069455 155 const char MY_GTW[] = "192.168.120.1"; // vz
klauss 69:65665afbad5d 156 ///< Indica o IP do Gateway de rede
Cola 20:2d6ab23956e5 157
klauss 119:ee6a53069455 158 const uint16_t RX_CB_IDLE = 300;
klauss 121:ee02790d00b7 159 ///< Tempo maximo ( countdown em segundos ) que a Header espera por algum pacote no lado fibra, deixa de tickar o wdt.
klauss 121:ee02790d00b7 160
klauss 119:ee6a53069455 161 const uint16_t ETH_CONNECT_TIMEOUT = 330;
klauss 121:ee02790d00b7 162 ///< Tempo maximo ( countdown em segundos ) que a Header espera tentando conectar na interface ETH, deixa de tickar o wdt quando chega em zero.
klauss 119:ee6a53069455 163
klauss 119:ee6a53069455 164 const uint16_t RTP_MSG_SIZE = 160;
klauss 121:ee02790d00b7 165 ///< Tamanho em bytes ocupados pelos pacotes de audio no sentido * -> Header -> CBx
klauss 81:3656f00ab3db 166
klauss 78:1353744f01e1 167 extern uint32_t pkg_zero;
klauss 78:1353744f01e1 168 ///< Contador de pacotes contendo somente zeros
klauss 121:ee02790d00b7 169
klauss 78:1353744f01e1 170 extern uint32_t pkg_ckserr;
klauss 69:65665afbad5d 171 ///< Contador de pacotes em que o checksum resultou divergente do calculado/recebido
klauss 121:ee02790d00b7 172
klauss 78:1353744f01e1 173 extern uint32_t pkg_cksok;
klauss 69:65665afbad5d 174 ///< Contador de pacotes em que o checksum resultou o mesmo calculado e o recebido
klauss 0:4d17cd9c8f9d 175
klauss 69:65665afbad5d 176 /**
klauss 69:65665afbad5d 177 * @Synopsis Calcula o checksum do pacote.
klauss 69:65665afbad5d 178 *
klauss 69:65665afbad5d 179 * @param buffer Um ponteiro para a região de memória onde os dados de interesse estão localizados.
klauss 69:65665afbad5d 180 * @param length O numero de elementos que serão considerados no cálculo do checksum
klauss 69:65665afbad5d 181 *
klauss 69:65665afbad5d 182 * @return 0 - caso em que o vetor apontado por buffer estiver setado em NULL. O checksum propriamente
klauss 69:65665afbad5d 183 * calculado caso contrário.
klauss 69:65665afbad5d 184 *
klauss 69:65665afbad5d 185 * Exemplo:
klauss 69:65665afbad5d 186 * @code
klauss 69:65665afbad5d 187 * ...
klauss 69:65665afbad5d 188 * // onde cb_buffer contém os dados vindos do Call_Box, Obs. as posições 4 e 5 contém o MSB e LSB do CC calculado pelo Call_Box.
klauss 69:65665afbad5d 189 * uint16_t cc = ( uint16_t )cb_buffer[ 4 ] << 8 | cb_buffer[ 5 ];
klauss 114:472502b31a12 190 * if( cc != __checksum__( cb_buffer, __CB_BUFFER_SIZE__ ) ){
klauss 69:65665afbad5d 191 * //faça alguma coisa ...
klauss 69:65665afbad5d 192 * }
klauss 69:65665afbad5d 193 * ...
klauss 69:65665afbad5d 194 * @endcode
klauss 69:65665afbad5d 195 */
klauss 121:ee02790d00b7 196 uint16_t vz_checksum ( uint8_t * buffer, size_t length );
klauss 0:4d17cd9c8f9d 197
klauss 0:4d17cd9c8f9d 198 /* incorporar a parte de cc */
klauss 69:65665afbad5d 199 /**
klauss 69:65665afbad5d 200 * @Synopsis Esta é a função responsável por, dado um pacote recebido dos CBx, quebra-lo em ramal( ext ), porta, type e dados.
klauss 69:65665afbad5d 201 *
klauss 69:65665afbad5d 202 * @param ext Um ponteiro para onde sera setado o ramal do CBx que enviou este pacote.
klauss 69:65665afbad5d 203 * @param port Um ponteiro para onde sera setado a porta do CBx que enviou este pacote.
klauss 69:65665afbad5d 204 * @param type Um ponteiro para onde sera setado o type de mensagem enviada pelo CBx.
klauss 69:65665afbad5d 205 * @param cb_buffer O pacote que se deseja decodificar.
klauss 69:65665afbad5d 206 *
klauss 69:65665afbad5d 207 * @return NULL, caso em que o checksum( cc ) calculado não bater com o cc recebido no pacote, retorna NULL também em pacotes do
klauss 69:65665afbad5d 208 * tipo flood, ou no caso em que o pacote recebido para processamento apontar para NULL; em todos esses casos os valores de ext,
klauss 69:65665afbad5d 209 * port e type devem ser desconsiderados para manter a integridade do processamento; retorna um ponteiro para o inicio dos dados
klauss 69:65665afbad5d 210 * enviados pelo CBx e seta ramal, porta e type nos casos em que o pacote recebido for válidado pelo protocolo.
klauss 69:65665afbad5d 211 *
klauss 69:65665afbad5d 212 * Exemplo:
klauss 69:65665afbad5d 213 * @code
klauss 69:65665afbad5d 214 * ...
klauss 69:65665afbad5d 215 * int ext, port, type;
klauss 114:472502b31a12 216 * uint8_t * data, buffer[ __CB_BUFFER_SIZE__ ];
klauss 69:65665afbad5d 217 * //assumindo que os dados vindos do Call_Box estão armazenados em buffer;
klauss 114:472502b31a12 218 * data = __parse_vz_pkg__( &ext, &port, &type, buffer );
klauss 69:65665afbad5d 219 * ...
klauss 69:65665afbad5d 220 * @endcode
klauss 69:65665afbad5d 221 */
klauss 69:65665afbad5d 222
klauss 69:65665afbad5d 223 /**
klauss 69:65665afbad5d 224 * \note Formato do pacote VZ :
klauss 69:65665afbad5d 225 *
klauss 69:65665afbad5d 226 * | E | E | P | P | C | C | T | [ Seq_num | Audio ] | 14[ Clock | Audio ] | [ TS | Audio ] |...|
klauss 69:65665afbad5d 227 *
klauss 69:65665afbad5d 228 * E = Ext = Ramal
klauss 69:65665afbad5d 229 *
klauss 69:65665afbad5d 230 * P = Port = Porta
klauss 69:65665afbad5d 231 *
klauss 69:65665afbad5d 232 * C = Checksum
klauss 69:65665afbad5d 233 *
klauss 69:65665afbad5d 234 * T = Type = Tipo
klauss 69:65665afbad5d 235 *
klauss 69:65665afbad5d 236 * Seq_num = Sequence Number = Numero de sequencia
klauss 69:65665afbad5d 237 *
klauss 69:65665afbad5d 238 * Clock = 14 bytes to sync
klauss 69:65665afbad5d 239 *
klauss 114:472502b31a12 240 * ...= demais __CB_BUFFER_SIZE__ - __VZ_HEADER_OFFSET__ bytes
klauss 69:65665afbad5d 241 *
klauss 69:65665afbad5d 242 */
klauss 121:ee02790d00b7 243 uint8_t * parse_vz_pkg ( int * ext, int * port, volatile uint8_t * type, uint8_t * cb_buffer );
klauss 69:65665afbad5d 244
klauss 69:65665afbad5d 245 /**
klauss 69:65665afbad5d 246 * @Synopsis Função responsavel por montar o pacote para envio para o CBx seguindo o formato do protocolo VZ.
klauss 69:65665afbad5d 247 *
klauss 69:65665afbad5d 248 * @param ext O ramal do CBx destino deste pacote.
klauss 69:65665afbad5d 249 * @param port A porta do CBx destino deste pacote.
klauss 69:65665afbad5d 250 * @param type O tipo do pacote que será enviado para o CBx.
klauss 69:65665afbad5d 251 * @param cb_buffer Os dados que serão colocados nesse pacote.
klauss 69:65665afbad5d 252 * @param seq_num O numero do sequência deste pacote.
klauss 69:65665afbad5d 253 * @param length O tamanho ( em bytes ) dos dados que serão enviados.
klauss 69:65665afbad5d 254 * @param pkg Um ponteiro que recebera o pacote montado e pronto para envio.
klauss 69:65665afbad5d 255 *
klauss 69:65665afbad5d 256 * @return O pacote montado e pronto para envio.
klauss 69:65665afbad5d 257 *
klauss 69:65665afbad5d 258 * Exemplo:
klauss 69:65665afbad5d 259 * @code
klauss 69:65665afbad5d 260 * ...
klauss 69:65665afbad5d 261 * int ext = 1011;
klauss 69:65665afbad5d 262 * port = 1011;
klauss 69:65665afbad5d 263 * type = __REGISTRY__;
klauss 114:472502b31a12 264 * send2callboxes( __build_cb_package__( ext, port, type,
klauss 114:472502b31a12 265 * ( char * )data, cb->get_msg_id(), __CB_BUFFER_SIZE__ - __VZ_HEADER_OFFSET__, write_buffer ) );
klauss 69:65665afbad5d 266 * ...
klauss 69:65665afbad5d 267 * @endcode
klauss 69:65665afbad5d 268 */
klauss 121:ee02790d00b7 269 uint8_t * build_cb_package ( int ext, int port, uint8_t type, char * cb_buffer, uint8_t seq_num, int length, uint8_t * pkg );
klauss 69:65665afbad5d 270
klauss 69:65665afbad5d 271 /**
klauss 69:65665afbad5d 272 * @Synopsis Obtém uma referência de clock de um servidor.
klauss 69:65665afbad5d 273 *
klauss 69:65665afbad5d 274 * @param buffer Imprime a referência do relógio nesta posição de memória.
klauss 69:65665afbad5d 275 *
klauss 69:65665afbad5d 276 * \note Por definição de projeto, o relógio ocupa 14 bytes, seguindo o formato
klauss 69:65665afbad5d 277 *
klauss 69:65665afbad5d 278 * | ano | ano | ano | ano | mes | mes | dia | dia | hora | hora | minuto | minuto | segundo | segundo |
klauss 69:65665afbad5d 279 *
klauss 69:65665afbad5d 280 * Exemplo:
klauss 69:65665afbad5d 281 *
klauss 69:65665afbad5d 282 * 20141105101235
klauss 69:65665afbad5d 283 */
klauss 0:4d17cd9c8f9d 284
klauss 121:ee02790d00b7 285 int init_ranges ( void );
klauss 81:3656f00ab3db 286
klauss 0:4d17cd9c8f9d 287 #endif