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@137:32dd35a6dbc9, 2015-11-24 (annotated)

Committer:
klauss
Date:
Tue Nov 24 14:06:22 2015 +0000
Revision:
137:32dd35a6dbc9
Parent:
135:2f4290590e51 
core source of the .bin (09/21/2015) in the field

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