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@122:480c44b0e205, 2015-05-11 (annotated)

Committer:
klauss
Date:
Mon May 11 15:16:36 2015 +0000
Revision:
122:480c44b0e205
Parent:
121:ee02790d00b7
Child:
123:1d395b5a4cad
E00 - Limitar em 1500 o show_sip

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