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@99:e80850c51106, 2015-01-19 (annotated)

Committer:
klauss
Date:
Mon Jan 19 18:00:42 2015 +0000
Revision:
99:e80850c51106
Parent:
87:679ee0d594a9
Child:
100:09a23fcd3bdf
wip header cb tx delay

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 0:4d17cd9c8f9d 12 #include <stdlib.h>
klauss 0:4d17cd9c8f9d 13 #include <stdint.h>
klauss 0:4d17cd9c8f9d 14 #include <string.h>
klauss 74:81c47fff88a5 15 #include "shared_variables.h" // for __RTP_HEADER_SIZE__
klauss 74:81c47fff88a5 16 #include "utils.h" // for xmemcpy
klauss 0:4d17cd9c8f9d 17 #include "bits.h"
klauss 0:4d17cd9c8f9d 18
klauss 99:e80850c51106 19 #define MIN_EXT 1
klauss 81:3656f00ab3db 20 extern int begin;
klauss 81:3656f00ab3db 21
klauss 99:e80850c51106 22 #define MAX_EXT 5999
klauss 81:3656f00ab3db 23 extern int end;
klauss 79:9bc12aa305a9 24
klauss 69:65665afbad5d 25 #define __START_PKG_COUNT__ 100
klauss 69:65665afbad5d 26 ///< Estabelece o inicio dos pacotes RTP, não utilizado atualmente
klauss 69:65665afbad5d 27 #define UDP_PORT_LISTENER 11406
klauss 69:65665afbad5d 28 ///< Porta UDP na qual a Header espera por eventuais mensagens.
klauss 69:65665afbad5d 29 #define TCP_PORT_LISTENER 7879
klauss 69:65665afbad5d 30 ///< Porta TCP na qual a Header espera por eventuais mensagens.
klauss 69:65665afbad5d 31 #define UDP_BOOTLOADER_PORT 9891
klauss 69:65665afbad5d 32 ///< Porta UDP para tratativas do procedimento de gravação dos CBx.
klauss 36:728498a78e1e 33
klauss 69:65665afbad5d 34 #define __UDP_PORT__ 7890
klauss 69:65665afbad5d 35 ///< Antiga porta UDP que a Header ouvia, descontinuado.
klauss 69:65665afbad5d 36 #define __TCP_PORT__ 8709
klauss 69:65665afbad5d 37 ///< Antiga porta TCP que a Header ouvia, descontinuado.
klauss 67:cdedc64d9921 38
klauss 69:65665afbad5d 39 #define __VZ_HEADER_OFFSET__ 7
klauss 69:65665afbad5d 40 ///< Indica o inicio dos dados recebidos efetivamente no pacote VZ.
klauss 69:65665afbad5d 41 #define __CB_BUFFER_SIZE__ 300
klauss 69:65665afbad5d 42 ///< Indica o numero máximo de bytes recebidos ( por pacote ) do CBx.
klauss 69:65665afbad5d 43 #define __PROMPT_ETH_BUFFER_SIZE__ 1024
klauss 69:65665afbad5d 44 ///< Representa o tamanho máximo do pacote recebido pelo prompt da Header.
klauss 69:65665afbad5d 45 #define __CLOCK_SYNC_SIZE__ 14
klauss 69:65665afbad5d 46 ///< Indica o numero de bytes ocupados pelo relogio no pacote transmitido.
klauss 69:65665afbad5d 47 #define __SEQ_NUM_SIZE__ 1
klauss 69:65665afbad5d 48 ///< Indica o numero de bytes ocupados para uso de sequence number.
klauss 69:65665afbad5d 49 #define __ETH_BUFFER_SIZE__ __CB_BUFFER_SIZE__ + __RTP_HEADER_SIZE__ + 1 // 313
klauss 69:65665afbad5d 50 ///< Indica o tamanho real do pacote que será enviado do CBx para o servidor via eth
klauss 69:65665afbad5d 51 #define __CB_AUDIO_DATA_SIZE__ 240
klauss 69:65665afbad5d 52 ///< Indica o numero de pacotes enviados pelo CBx referente a dados de audio.
klauss 69:65665afbad5d 53 #define __CHECKSUM_OFFSET__ 7
klauss 69:65665afbad5d 54 ///< Indica o deslocamento em relação ao começo do pacote enviado pelo CBx onde se encontra o cc.
klauss 69:65665afbad5d 55 #define __TIMESLICE_PLACE__ 22
klauss 69:65665afbad5d 56 ///< Indica o local ( em relação ao começo do pacote ) onde se encontra o timeslice.
klauss 0:4d17cd9c8f9d 57
klauss 87:679ee0d594a9 58 #define __MAX_CB_IN_A_BRANCH__ 52
klauss 78:1353744f01e1 59 ///< Estabelece o nro máximo de CBx em um mesmo ramo
klauss 69:65665afbad5d 60
klauss 69:65665afbad5d 61 #define __READ__ 0x01
klauss 69:65665afbad5d 62 ///< Define o estado ( na main ) de que existe um dados disponivel para leitura.
klauss 69:65665afbad5d 63 #define __WAITING__ 0x00
klauss 69:65665afbad5d 64 ///< Define o estado ( na main ) de que esta apenas esperando por um novo pacote vindo dos CBx.
klauss 0:4d17cd9c8f9d 65
klauss 69:65665afbad5d 66 #define __BOOT__ 0x00
klauss 69:65665afbad5d 67 ///< Indica o tipo boot, enviado pelo CBx, assim que o mesmo liga ou sofre reboot.
klauss 69:65665afbad5d 68 #define __REGISTRY__ 0x02
klauss 69:65665afbad5d 69 ///< Tipo de registro, enviado pelo CBx, quando o mesmo quer se registrar, enviado pela Header para verificar se determinado CBx ainda esta ativo.
klauss 0:4d17cd9c8f9d 70 #define __INVITE__ 0x04
klauss 69:65665afbad5d 71 ///< Representa o tipo de pedido de invite, enviado pelo CBx sempre quando o mesmo quer iniciar uma ligação com o server.
klauss 0:4d17cd9c8f9d 72 #define __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 0:4d17cd9c8f9d 74 #define __TELEMETRY__ 0x10
klauss 69:65665afbad5d 75 ///< Define o tipo de pacote de telemetria enviado pelo CBx.
klauss 67:cdedc64d9921 76 #define __BOOTLOADER_CBX__ 0x12
klauss 69:65665afbad5d 77 ///< Define o tipo de pacote para a gravação do CBx
klauss 0:4d17cd9c8f9d 78 #define __CB_BYE__ 0x20
klauss 69:65665afbad5d 79 ///< Representa o tipo de pacote que o CBx envia para a Header solicitando o final da ligação.
Cola 21:0bd688722e81 80 #define __PROMPT__ 0x01
klauss 69:65665afbad5d 81 ///< Identifica o tipo de pacote responsavel por mandar comandos executáveis no Cbx.
klauss 48:195c97f12e8e 82 #define __FLOOD__ 0x40
klauss 69:65665afbad5d 83 ///< Representa os pacotes de flood, úteis para validação de comunicação Header-CBx.
klauss 99:e80850c51106 84 #define __FW__ 0x50
klauss 99:e80850c51106 85 ///< Tipo para redirecionamento semn tratamento para uma determinada porta UDP pré-configurada.
klauss 99:e80850c51106 86 #define __FW1__ 0x51
klauss 99:e80850c51106 87 ///< Tipo para redirecionamento semn tratamento para uma determinada porta UDP pré-configurada.
klauss 99:e80850c51106 88 #define __FW2__ 0x52
klauss 99:e80850c51106 89 ///< Tipo para redirecionamento semn tratamento para uma determinada porta UDP pré-configurada.
klauss 99:e80850c51106 90 #define __FW3__ 0x53
klauss 99:e80850c51106 91 ///< Tipo para redirecionamento semn tratamento para uma determinada porta UDP pré-configurada.
klauss 99:e80850c51106 92 #define __FW4__ 0x54
klauss 99:e80850c51106 93 ///< Tipo para redirecionamento semn tratamento para uma determinada porta UDP pré-configurada.
klauss 99:e80850c51106 94 #define __FW5__ 0x55
klauss 99:e80850c51106 95 ///< Tipo para redirecionamento semn tratamento para uma determinada porta UDP pré-configurada.
klauss 99:e80850c51106 96 #define __FW6__ 0x56
klauss 99:e80850c51106 97 ///< Tipo para redirecionamento semn tratamento para uma determinada porta UDP pré-configurada.
klauss 99:e80850c51106 98
klauss 99:e80850c51106 99
klauss 99:e80850c51106 100 #define __CB_STATS__ 0x07
klauss 99:e80850c51106 101
klauss 0:4d17cd9c8f9d 102 #define __DO_NOTHING__ 0x99
klauss 69:65665afbad5d 103 ///< Representa o tipo de idle, importante para algumas comunicações.
klauss 0:4d17cd9c8f9d 104
klauss 29:7246460b73f8 105 //#define __MY_IP__ "192.168.2.200"
klauss 48:195c97f12e8e 106 //#define __MY_IP__ "192.168.2.201"
klauss 50:d9b6577a70f5 107 #define __MY_IP__ "192.168.120.171"
klauss 69:65665afbad5d 108 ///< Representa o IP default da Header.
klauss 28:94aec56c6329 109 #define __MY_EXT__ 820
klauss 69:65665afbad5d 110 ///< Indica o ramal default da Header.
klauss 28:94aec56c6329 111 #define __MY_PORT__ 5062
klauss 69:65665afbad5d 112 ///< Representa a porta default da Header.
klauss 28:94aec56c6329 113
klauss 28:94aec56c6329 114 #define __SERVER_IP__ "192.168.120.120"
klauss 69:65665afbad5d 115 ///< Indica o IP defaut do servidor para onde a Header ira encaminhar pedidos de ligação.
klauss 48:195c97f12e8e 116 //#define __SERVER_IP__ "192.168.30.25"
klauss 29:7246460b73f8 117
klauss 69:65665afbad5d 118 //FIXME pode dar inconssistencia.
klauss 69:65665afbad5d 119 //#define __RTP_SEVER_IP__ "192.168.120.120"
klauss 69:65665afbad5d 120 #define __RTP_SEVER_IP__ __SERVER_IP__
klauss 69:65665afbad5d 121 ///< Referencia ao envio de dados RTP
klauss 69:65665afbad5d 122
klauss 28:94aec56c6329 123 #define __PEER_EXT__ 913
klauss 69:65665afbad5d 124 ///< Estabelece o ramal default para onde a Header ira direcionar os pedidos de ligações.
klauss 48:195c97f12e8e 125 //#define __PEER_EXT__ 812
klauss 28:94aec56c6329 126 #define __SERVER_PORT__ 5075
klauss 69:65665afbad5d 127 ///< Indica a porta default do server para onde os pacotes eth serão enviados na negociação SIP.
klauss 48:195c97f12e8e 128 //#define __SERVER_PORT__ 5060
klauss 28:94aec56c6329 129
klauss 43:455522f98de5 130 #define __MY_MSK__ "255.255.255.0"
klauss 69:65665afbad5d 131 ///< Indica a mascara de rede onde a Header se encontra.
klauss 50:d9b6577a70f5 132 //#define __MY_GTW__ "192.168.2.254" // colinas
klauss 81:3656f00ab3db 133 #define __MY_GTW__ "192.168.120.1" // vz
klauss 69:65665afbad5d 134 ///< Indica o IP do Gateway de rede
Cola 20:2d6ab23956e5 135
klauss 81:3656f00ab3db 136 #define RX_CB_IDLE 300
klauss 81:3656f00ab3db 137 #define EXTERN_WDT_IDLE 630
klauss 81:3656f00ab3db 138 #define ETH_CONNECT_TIMEOUT 330
klauss 81:3656f00ab3db 139
klauss 78:1353744f01e1 140 extern uint32_t pkg_zero;
klauss 78:1353744f01e1 141 ///< Contador de pacotes contendo somente zeros
klauss 78:1353744f01e1 142 extern uint32_t pkg_ckserr;
klauss 69:65665afbad5d 143 ///< Contador de pacotes em que o checksum resultou divergente do calculado/recebido
klauss 78:1353744f01e1 144 extern uint32_t pkg_cksok;
klauss 69:65665afbad5d 145 ///< Contador de pacotes em que o checksum resultou o mesmo calculado e o recebido
klauss 0:4d17cd9c8f9d 146
klauss 69:65665afbad5d 147 /**
klauss 69:65665afbad5d 148 * @Synopsis Calcula o checksum do pacote.
klauss 69:65665afbad5d 149 *
klauss 69:65665afbad5d 150 * @param buffer Um ponteiro para a região de memória onde os dados de interesse estão localizados.
klauss 69:65665afbad5d 151 * @param length O numero de elementos que serão considerados no cálculo do checksum
klauss 69:65665afbad5d 152 *
klauss 69:65665afbad5d 153 * @return 0 - caso em que o vetor apontado por buffer estiver setado em NULL. O checksum propriamente
klauss 69:65665afbad5d 154 * calculado caso contrário.
klauss 69:65665afbad5d 155 *
klauss 69:65665afbad5d 156 * Exemplo:
klauss 69:65665afbad5d 157 * @code
klauss 69:65665afbad5d 158 * ...
klauss 69:65665afbad5d 159 * // 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 160 * uint16_t cc = ( uint16_t )cb_buffer[ 4 ] << 8 | cb_buffer[ 5 ];
klauss 69:65665afbad5d 161 * if( cc != __checksum__( cb_buffer, __CB_BUFFER_SIZE__ ) ){
klauss 69:65665afbad5d 162 * //faça alguma coisa ...
klauss 69:65665afbad5d 163 * }
klauss 69:65665afbad5d 164 * ...
klauss 69:65665afbad5d 165 * @endcode
klauss 69:65665afbad5d 166 */
klauss 0:4d17cd9c8f9d 167 uint16_t __checksum__( uint8_t * buffer, size_t length );
klauss 0:4d17cd9c8f9d 168
klauss 0:4d17cd9c8f9d 169 /* incorporar a parte de cc */
klauss 69:65665afbad5d 170 /**
klauss 69:65665afbad5d 171 * @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 172 *
klauss 69:65665afbad5d 173 * @param ext Um ponteiro para onde sera setado o ramal do CBx que enviou este pacote.
klauss 69:65665afbad5d 174 * @param port Um ponteiro para onde sera setado a porta do CBx que enviou este pacote.
klauss 69:65665afbad5d 175 * @param type Um ponteiro para onde sera setado o type de mensagem enviada pelo CBx.
klauss 69:65665afbad5d 176 * @param cb_buffer O pacote que se deseja decodificar.
klauss 69:65665afbad5d 177 *
klauss 69:65665afbad5d 178 * @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 179 * 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 180 * port e type devem ser desconsiderados para manter a integridade do processamento; retorna um ponteiro para o inicio dos dados
klauss 69:65665afbad5d 181 * enviados pelo CBx e seta ramal, porta e type nos casos em que o pacote recebido for válidado pelo protocolo.
klauss 69:65665afbad5d 182 *
klauss 69:65665afbad5d 183 * Exemplo:
klauss 69:65665afbad5d 184 * @code
klauss 69:65665afbad5d 185 * ...
klauss 69:65665afbad5d 186 * int ext, port, type;
klauss 69:65665afbad5d 187 * uint8_t * data, buffer[ __CB_BUFFER_SIZE__ ];
klauss 69:65665afbad5d 188 * //assumindo que os dados vindos do Call_Box estão armazenados em buffer;
klauss 69:65665afbad5d 189 * data = __parse_vz_pkg__( &ext, &port, &type, buffer );
klauss 69:65665afbad5d 190 * ...
klauss 69:65665afbad5d 191 * @endcode
klauss 69:65665afbad5d 192 */
klauss 69:65665afbad5d 193
klauss 69:65665afbad5d 194 /**
klauss 69:65665afbad5d 195 * \note Formato do pacote VZ :
klauss 69:65665afbad5d 196 *
klauss 69:65665afbad5d 197 * | E | E | P | P | C | C | T | [ Seq_num | Audio ] | 14[ Clock | Audio ] | [ TS | Audio ] |...|
klauss 69:65665afbad5d 198 *
klauss 69:65665afbad5d 199 * E = Ext = Ramal
klauss 69:65665afbad5d 200 *
klauss 69:65665afbad5d 201 * P = Port = Porta
klauss 69:65665afbad5d 202 *
klauss 69:65665afbad5d 203 * C = Checksum
klauss 69:65665afbad5d 204 *
klauss 69:65665afbad5d 205 * T = Type = Tipo
klauss 69:65665afbad5d 206 *
klauss 69:65665afbad5d 207 * Seq_num = Sequence Number = Numero de sequencia
klauss 69:65665afbad5d 208 *
klauss 69:65665afbad5d 209 * Clock = 14 bytes to sync
klauss 69:65665afbad5d 210 *
klauss 69:65665afbad5d 211 * ...= demais __CB_BUFFER_SIZE__ - __VZ_HEADER_OFFSET__ bytes
klauss 69:65665afbad5d 212 *
klauss 69:65665afbad5d 213 */
klauss 34:f19d9735428e 214 uint8_t * __parse_vz_pkg__( int * ext, int * port, volatile uint8_t * type, uint8_t * cb_buffer );
klauss 69:65665afbad5d 215
klauss 69:65665afbad5d 216 /**
klauss 69:65665afbad5d 217 * @Synopsis Função responsavel por montar o pacote para envio para o CBx seguindo o formato do protocolo VZ.
klauss 69:65665afbad5d 218 *
klauss 69:65665afbad5d 219 * @param ext O ramal do CBx destino deste pacote.
klauss 69:65665afbad5d 220 * @param port A porta do CBx destino deste pacote.
klauss 69:65665afbad5d 221 * @param type O tipo do pacote que será enviado para o CBx.
klauss 69:65665afbad5d 222 * @param cb_buffer Os dados que serão colocados nesse pacote.
klauss 69:65665afbad5d 223 * @param seq_num O numero do sequência deste pacote.
klauss 69:65665afbad5d 224 * @param length O tamanho ( em bytes ) dos dados que serão enviados.
klauss 69:65665afbad5d 225 * @param pkg Um ponteiro que recebera o pacote montado e pronto para envio.
klauss 69:65665afbad5d 226 *
klauss 69:65665afbad5d 227 * @return O pacote montado e pronto para envio.
klauss 69:65665afbad5d 228 *
klauss 69:65665afbad5d 229 * Exemplo:
klauss 69:65665afbad5d 230 * @code
klauss 69:65665afbad5d 231 * ...
klauss 69:65665afbad5d 232 * int ext = 1011;
klauss 69:65665afbad5d 233 * port = 1011;
klauss 69:65665afbad5d 234 * type = __REGISTRY__;
klauss 74:81c47fff88a5 235 * send2callboxes( __build_cb_package__( ext, port, type,
klauss 69:65665afbad5d 236 * ( char * )data, cb->get_msg_id(), __CB_BUFFER_SIZE__ - __VZ_HEADER_OFFSET__, write_buffer ) );
klauss 69:65665afbad5d 237 * ...
klauss 69:65665afbad5d 238 * @endcode
klauss 69:65665afbad5d 239 */
klauss 0:4d17cd9c8f9d 240 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 241
klauss 69:65665afbad5d 242 /**
klauss 69:65665afbad5d 243 * @Synopsis Função que seria responsavel pelo envio de pacotes eth, porém descontinuada, será removida no futuro.
klauss 69:65665afbad5d 244 *
klauss 69:65665afbad5d 245 * @return O pacote pronto para envio via protocolo eth.
klauss 69:65665afbad5d 246 *
klauss 69:65665afbad5d 247 * \note Não implementada.
klauss 69:65665afbad5d 248 */
klauss 0:4d17cd9c8f9d 249 char * __build_eth__package__( void );
klauss 69:65665afbad5d 250
klauss 69:65665afbad5d 251 /**
klauss 69:65665afbad5d 252 * @Synopsis Obtém uma referência de clock de um servidor.
klauss 69:65665afbad5d 253 *
klauss 69:65665afbad5d 254 * @param buffer Imprime a referência do relógio nesta posição de memória.
klauss 69:65665afbad5d 255 *
klauss 69:65665afbad5d 256 * \note Por definição de projeto, o relógio ocupa 14 bytes, seguindo o formato
klauss 69:65665afbad5d 257 *
klauss 69:65665afbad5d 258 * | ano | ano | ano | ano | mes | mes | dia | dia | hora | hora | minuto | minuto | segundo | segundo |
klauss 69:65665afbad5d 259 *
klauss 69:65665afbad5d 260 * Exemplo:
klauss 69:65665afbad5d 261 *
klauss 69:65665afbad5d 262 * 20141105101235
klauss 69:65665afbad5d 263 */
klauss 0:4d17cd9c8f9d 264 void __print_clock__( uint8_t * buffer );
klauss 0:4d17cd9c8f9d 265
klauss 81:3656f00ab3db 266 void init_ranges( void );
klauss 81:3656f00ab3db 267
klauss 0:4d17cd9c8f9d 268 #endif