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

utils.h@74:81c47fff88a5, 2014-11-24 (annotated)

Committer:
klauss
Date:
Mon Nov 24 16:43:16 2014 +0000
Revision:
74:81c47fff88a5
Parent:
72:895ca792c647
Child:
78:1353744f01e1
validando organiza??o de arquivos | ainda em desenvolvimento.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
klauss 69:65665afbad5d 1 /**
klauss 69:65665afbad5d 2 * @file utils.h
klauss 69:65665afbad5d 3 * @Synopsis Funções de propósito geral são encontradas nesse arquivo.
klauss 69:65665afbad5d 4 * @author Jhonatan Casale
klauss 69:65665afbad5d 5 * @version 1
klauss 69:65665afbad5d 6 * @date 2014-11-06
klauss 69:65665afbad5d 7 */
klauss 69:65665afbad5d 8
klauss 0:4d17cd9c8f9d 9 #ifndef __UTILS_H__
klauss 0:4d17cd9c8f9d 10 #define __UTILS_H__
klauss 0:4d17cd9c8f9d 11
klauss 74:81c47fff88a5 12 #include <iostream> // need for swap
klauss 0:4d17cd9c8f9d 13 #include "mbed.h"
klauss 74:81c47fff88a5 14 #include "shared_variables.h"
klauss 74:81c47fff88a5 15 #include "debug.h"
klauss 72:895ca792c647 16
klauss 0:4d17cd9c8f9d 17 using namespace std;
klauss 0:4d17cd9c8f9d 18
klauss 14:22a35f575502 19 #define set_status(a,b) _set_status(a,b)
klauss 14:22a35f575502 20 #define _set_status(a,b){ \
klauss 31:bb5fb28a77df 21 if( a != b ) if( debug_sip )debug_msg("Anterior %d -- Atual %d", a, b ); \
klauss 14:22a35f575502 22 if( a != NULL || b != NULL ) a = b; \
klauss 31:bb5fb28a77df 23 else if( debug_sip ) debug_msg("Paramento sip null"); \
klauss 14:22a35f575502 24 }
klauss 0:4d17cd9c8f9d 25
klauss 69:65665afbad5d 26 /**
klauss 69:65665afbad5d 27 * @Synopsis Transpões os elementos de um vetor, invertendo a ordendo em que os mesmos aparecem.
klauss 69:65665afbad5d 28 *
klauss 69:65665afbad5d 29 * @param str[] Um ponteiro para o inicio da string que desejamos inverter os elementos de posição
klauss 69:65665afbad5d 30 * @param length O numero de elementos que queremos trocar.
klauss 69:65665afbad5d 31 *
klauss 69:65665afbad5d 32 * Exemplo:
klauss 69:65665afbad5d 33 * @code
klauss 69:65665afbad5d 34 * ...
klauss 69:65665afbad5d 35 * char str[ 256 ] = "This is a only test";
klauss 69:65665afbad5d 36 * reverse( str, strlen( str ) );
klauss 69:65665afbad5d 37 * ...
klauss 69:65665afbad5d 38 * @endcode
klauss 69:65665afbad5d 39 */
klauss 0:4d17cd9c8f9d 40 void reverse( char str[], int length );
klauss 69:65665afbad5d 41
klauss 69:65665afbad5d 42 /**
klauss 69:65665afbad5d 43 * @Synopsis Implementa a funcionalidade de, dado um numero em uma base, converte o mesmo para seu equivalente em string.
klauss 69:65665afbad5d 44 *
klauss 69:65665afbad5d 45 * @param num O numero que se deseja converter em string.
klauss 69:65665afbad5d 46 * @param str Um ponteiro para o inicio da região de memória onde será montado a string.
klauss 69:65665afbad5d 47 * @param base A base de conversão adotada.
klauss 69:65665afbad5d 48 *
klauss 69:65665afbad5d 49 * @return Um ponteiro para o primeiro elemento da string montada.
klauss 69:65665afbad5d 50 *
klauss 69:65665afbad5d 51 * Exemplo:
klauss 69:65665afbad5d 52 * @code
klauss 69:65665afbad5d 53 * ...
klauss 69:65665afbad5d 54 * int tmp = 119;
klauss 69:65665afbad5d 55 * char buffer[ 16 ];
klauss 69:65665afbad5d 56 * buffer = itoa( tmp, buffer, 10 );
klauss 69:65665afbad5d 57 * ...
klauss 69:65665afbad5d 58 * @endcode
klauss 69:65665afbad5d 59 */
klauss 0:4d17cd9c8f9d 60 char* itoa(int num, char* str, int base);
klauss 69:65665afbad5d 61
klauss 69:65665afbad5d 62 /**
klauss 69:65665afbad5d 63 * @Synopsis Função responsavel por apagar todos os leds em uso da Header.
klauss 69:65665afbad5d 64 *
klauss 69:65665afbad5d 65 * Exemplo:
klauss 69:65665afbad5d 66 * @code
klauss 69:65665afbad5d 67 * ...
klauss 69:65665afbad5d 68 * reset_leds();
klauss 69:65665afbad5d 69 * ...
klauss 69:65665afbad5d 70 * @endcode
klauss 69:65665afbad5d 71 */
klauss 0:4d17cd9c8f9d 72 void reset_leds( void );
klauss 69:65665afbad5d 73
klauss 69:65665afbad5d 74 /**
klauss 69:65665afbad5d 75 * @Synopsis Responsavel por escutar a porta de conexão com o servidor, verificando se o mesmo mandou algum dado.
klauss 69:65665afbad5d 76 *
klauss 69:65665afbad5d 77 * @param v_cb Um vetor contendo todos os Call_box conhecidos pela Header em um determinado momento.
klauss 69:65665afbad5d 78 * @param v_call Um vetor contendo todas as vz_calls em andamento em um dado momento.
klauss 69:65665afbad5d 79 *
klauss 69:65665afbad5d 80 * @return 0 ( zero ) se tudo correu bem, um numero menor do que zero, caso algum problema tenha acontecido na execusão, e um numero
klauss 69:65665afbad5d 81 * maior que zero indicando o ramal que deve ser removido do vetor de ligações.
klauss 69:65665afbad5d 82 *
klauss 69:65665afbad5d 83 * Exemplo:
klauss 69:65665afbad5d 84 * @code
klauss 69:65665afbad5d 85 * ...
klauss 69:65665afbad5d 86 * Vector * v_cb = new Vector();
klauss 69:65665afbad5d 87 * Vector * v_call = new Vector();
klauss 69:65665afbad5d 88 * // assumindo que os vetores já foram populados.
klauss 69:65665afbad5d 89 * int ret = sip_manager( v_cb, v_call );
klauss 69:65665afbad5d 90 * if( ret > 0x00 ){
klauss 69:65665afbad5d 91 * // tratar esse request
klauss 69:65665afbad5d 92 * }
klauss 69:65665afbad5d 93 * ...
klauss 69:65665afbad5d 94 * @endcode
klauss 69:65665afbad5d 95 */
klauss 72:895ca792c647 96
klauss 69:65665afbad5d 97 /**
klauss 69:65665afbad5d 98 * @Synopsis Função usada na ordenação dos CBx para exibição no comando "ls"
klauss 69:65665afbad5d 99 *
klauss 69:65665afbad5d 100 * @param a O primeiro ramal que se quer comparar.
klauss 69:65665afbad5d 101 * @param b O segundo ramal que se quer comparar.
klauss 69:65665afbad5d 102 *
klauss 69:65665afbad5d 103 * @return 0 ( zero ) se os valores forem iguais, maior que zero, se o primeiro valor ser maior que o segundo e retorna um numero
klauss 69:65665afbad5d 104 * negativo, caso o segundo valor seja maior que o primeiro.
klauss 69:65665afbad5d 105 *
klauss 69:65665afbad5d 106 * Exemplo:
klauss 69:65665afbad5d 107 * @code
klauss 69:65665afbad5d 108 * ...
klauss 69:65665afbad5d 109 * int a = 10;
klauss 69:65665afbad5d 110 * int b = 119;
klauss 69:65665afbad5d 111 * int result = ls_comp( ( const void * )&a, ( const void * )&b );
klauss 69:65665afbad5d 112 * ...
klauss 69:65665afbad5d 113 * @endcode
klauss 69:65665afbad5d 114 */
klauss 62:07e5bdc9f8f7 115 int ls_comp( const void * a, const void * b );
klauss 0:4d17cd9c8f9d 116
klauss 69:65665afbad5d 117 /**
klauss 74:81c47fff88a5 118 * @Synopsis Função que converte o ramal para a porta, por definição de projeto, cara ramo possui o numero da centena incremental
klauss 74:81c47fff88a5 119 * permanecendo o resto igual, por exemplo no ramo pilo os ramais são 5000, 5001 -- no lote 1 5100, 5101 -- porem a porta sempre
klauss 74:81c47fff88a5 120 * se manteve a mesma, o CBx esta configurado como ramal 5000 e porta 5000, assim como o ramal 5100 e porta 5000, em outras palavras
klauss 74:81c47fff88a5 121 * dado um ramal, calcular a porta é o mesmo que eliminar a centena do numero.
klauss 74:81c47fff88a5 122 *
klauss 74:81c47fff88a5 123 * @param ext O ramal do qual se quer calcular a porta vinculada.
klauss 74:81c47fff88a5 124 *
klauss 74:81c47fff88a5 125 * @return O valor calculado da porta.
klauss 74:81c47fff88a5 126 *
klauss 74:81c47fff88a5 127 * Exemplo:
klauss 74:81c47fff88a5 128 * @code
klauss 74:81c47fff88a5 129 * ...
klauss 74:81c47fff88a5 130 * int ext = 5220;
klauss 74:81c47fff88a5 131 * int port = convert_ext_to_port( ext );
klauss 74:81c47fff88a5 132 * ...
klauss 74:81c47fff88a5 133 * @endcode
klauss 69:65665afbad5d 134 */
klauss 74:81c47fff88a5 135 int convert_ext_to_port( int ext );
klauss 69:65665afbad5d 136
klauss 74:81c47fff88a5 137 void xstrcpy( uint8_t * dest, const uint8_t * src);
klauss 74:81c47fff88a5 138 void xmemcpy( uint8_t * dest, uint8_t * src, uint16_t size);
klauss 74:81c47fff88a5 139 void xmemcpy32(uint32_t * dest, uint32_t * src, uint16_t size);
klauss 0:4d17cd9c8f9d 140 #endif