Modularizando o src

Dependencies:   EALib EthernetInterface_vz mbed-rtos mbed

Fork of header_main_colinas_V0-20-09-14 by VZTECH

utils.h

Committer:
klauss
Date:
2015-04-30
Revision:
119:ee6a53069455
Parent:
117:e9facba9db27
Child:
121:ee02790d00b7

File content as of revision 119:ee6a53069455:

/**
 * @file utils.h
 * @Synopsis Funções de propósito geral são encontradas nesse arquivo. 
 * @author Jhonatan Casale
 * @version 1
 * @date 2014-11-06
 */

#ifndef __UTILS_H__
#define __UTILS_H__

#include <iostream> // need for swap
#include "mbed.h"
#include "shared_variables.h"
#include "debug.h"

#define reset_leds() { led1 = led2 = 1; led3 = led4 = 0; }

#define set_status(a,b) _set_status(a,b)
#define _set_status(a,b){ \
  if( a != b ) if( debug_sip )debug_msg("Anterior %d -- Atual %d", a, b ); \
  if( a != NULL || b != NULL ) a = b; \
  else if( debug_sip ) debug_msg("Paramento sip null"); \
}

/**
 * @Synopsis Transpões os elementos de um vetor, invertendo a ordendo em que os mesmos aparecem.
 *
 * @param str[] Um ponteiro para o inicio da string que desejamos inverter os elementos de posição
 * @param length O numero de elementos que queremos trocar.
 *
 * Exemplo:
 * @code
 * ...
 *  char str[ 256 ] = "This is a only test";
 *  reverse( str, strlen( str ) );
 * ...
 * @endcode
 */
void reverse( char str[], int length );

/**
 * @Synopsis Implementa a funcionalidade de, dado um numero em uma base, converte o mesmo para seu equivalente em string.
 *
 * @param num O numero que se deseja converter em string.
 * @param str Um ponteiro para o inicio da região de memória onde será montado a string.
 * @param base A base de conversão adotada.
 *
 * @return Um ponteiro para o primeiro elemento da string montada.
 *
 * Exemplo:
 * @code
 * ...
 *  int tmp = 119;
 *  char buffer[ 16 ];
 *  buffer = itoa( tmp, buffer, 10 );
 * ...
 * @endcode
 */
char* itoa(int num, char* str, int base);

/**
 * @Synopsis Responsavel por escutar a porta de conexão com o servidor, verificando se o mesmo mandou algum dado.
 *
 * @param v_cb Um vetor contendo todos os Call_box conhecidos pela Header em um determinado momento.
 * @param v_call Um vetor contendo todas as vz_calls em andamento em um dado momento.
 *
 * @return 0 ( zero ) se tudo correu bem, um numero menor do que zero, caso algum problema tenha acontecido na execusão, e um numero
 * maior que zero indicando o ramal que deve ser removido do vetor de ligações.
 *
 * Exemplo:
 * @code
 * ...
 *  Vector * v_cb = new Vector();
 *  Vector * v_call = new Vector();
 *      // assumindo que os vetores já foram populados.
 *  int ret = sip_manager( v_cb, v_call );                                                                  
 *  if( ret > 0x00 ){
 *          // tratar esse request
 *  }          
 * ...
 * @endcode
 */

/**
 * @Synopsis Função usada na ordenação dos CBx para exibição no comando "ls"
 *
 * @param a O primeiro ramal que se quer comparar.
 * @param b O segundo ramal que se quer comparar.
 *
 * @return 0 ( zero ) se os valores forem iguais, maior que zero, se o primeiro valor ser maior que o segundo e retorna um numero
 * negativo, caso o segundo valor seja maior que o primeiro.
 *
 * Exemplo:
 * @code
 * ...
 *  int a = 10;
 *  int b = 119;
 *  int result = ls_comp( ( const void * )&a, ( const void * )&b );
 * ...
 * @endcode
 */
int ls_comp( const void * a, const void * b );

/**
 * @Synopsis Função que converte o ramal para a porta, por definição de projeto, cara ramo possui o numero da centena incremental
 * permanecendo o resto igual, por exemplo no ramo pilo os ramais são 5000, 5001 -- no lote 1 5100, 5101 -- porem a porta sempre
 * 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
 * dado um ramal, calcular a porta é o mesmo que eliminar a centena do numero.
 *
 * @param ext O ramal do qual se quer calcular a porta vinculada.
 *
 * @return O valor calculado da porta.
 *
 * Exemplo:
 * @code
 * ...
 *  int ext = 5220;
 *  int port = convert_ext_to_port( ext );
 * ...
 * @endcode
 */
int convert_ext_to_port( int ext );

void xstrcpy( uint8_t * dest, const uint8_t * src);
void xmemcpy( uint8_t * dest, const uint8_t * src, uint16_t size );
void xmemcpy32( uint32_t * dest, uint32_t * src, uint16_t size );
uint8_t xstrmatch( const uint8_t * s1, const uint8_t * s2 );
uint8_t xmemmatch(const uint8_t * s1, const uint8_t * s2, uint16_t size);

int hex_init(void);                                             
char * hex8 (uint8_t i);                                         
char * hex16 (uint16_t i); 

#endif