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@69:65665afbad5d, 2014-11-12 (annotated)

Committer:
klauss
Date:
Wed Nov 12 13:25:54 2014 +0000
Revision:
69:65665afbad5d
Parent:
68:b54993674190
Child:
72:895ca792c647
versao em re-valida??o a priori, os dados de audio est?o se perdendo

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