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

prompt.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 prompt.h
klauss 69:65665afbad5d 3 * @Synopsis Implementa as funcionalidades de prompt/prompt-eth da Header.
klauss 69:65665afbad5d 4 * @author Fernando Cola / Jhontan Casale
klauss 69:65665afbad5d 5 * @version 1
klauss 69:65665afbad5d 6 * @date 2014-11-05
klauss 69:65665afbad5d 7 */
klauss 69:65665afbad5d 8
klauss 17:67a6b557eda5 9 #ifndef _PROMPT_H
klauss 17:67a6b557eda5 10 #define _PROMPT_H
klauss 17:67a6b557eda5 11
klauss 74:81c47fff88a5 12 #include <stdint.h>
klauss 44:cc4996469404 13 #include "mbed.h"
klauss 74:81c47fff88a5 14 #include "EthernetInterface.h"
klauss 74:81c47fff88a5 15 #include "telemetry.h" // used for __TELEMETRY_SERVER_IP__ and __TELEMETRY_SERVER_PORT__
klauss 74:81c47fff88a5 16 #include "utils.h" // need for convert_ext_to_port()
klauss 44:cc4996469404 17 #include "flood.h"
klauss 74:81c47fff88a5 18 #include "shared_variables.h"
klauss 74:81c47fff88a5 19 #include "debug.h"
klauss 74:81c47fff88a5 20 #include "wdt_manager.h"
klauss 74:81c47fff88a5 21 #include "file_system_manager.h"
klauss 44:cc4996469404 22
klauss 69:65665afbad5d 23 #define TCP_IDLE_MAX_TIME 45
klauss 69:65665afbad5d 24 ///< Define o tempo maximo de espera por um novo comando via eth, dado que já estamos em uma sessão TCP
klauss 69:65665afbad5d 25
klauss 58:af7e8788f106 26 #define DEBUGBUFSIZE 50
klauss 69:65665afbad5d 27 ///< Define o tamanho do buffer de entrada de dados.
klauss 44:cc4996469404 28
klauss 17:67a6b557eda5 29 extern uint8_t dog;
klauss 69:65665afbad5d 30 ///< Variável de controle que ativa a mensagem de boas vindas.
klauss 69:65665afbad5d 31
klauss 69:65665afbad5d 32 extern FILE *fmask; ///< arquivo de mascara de rede
klauss 69:65665afbad5d 33 extern FILE *fgate; ///< arquivo de gateway ip
klauss 69:65665afbad5d 34
klauss 69:65665afbad5d 35 extern FILE *fip; ///< arquivo de header ip
klauss 69:65665afbad5d 36 extern FILE *fext; ///< arquivo de header ext
klauss 69:65665afbad5d 37 extern FILE *fport; ///< arquivo de header sip port
klauss 69:65665afbad5d 38
klauss 69:65665afbad5d 39 extern FILE *fsip; ///< arquivo de server sip ip
klauss 69:65665afbad5d 40 extern FILE *fserext; ///< arquivo de server sip ext
klauss 69:65665afbad5d 41 extern FILE *fsport; ///< arquivo de server sip port
klauss 69:65665afbad5d 42
klauss 69:65665afbad5d 43 extern FILE *fudpport; ///< arquivo de porta udp que a header escuta
klauss 69:65665afbad5d 44 extern FILE *ftcpport; ///< arquivo de porta tcp que a header escuta
klauss 69:65665afbad5d 45 extern FILE *ftip; ///< arquivo de IP do servidor para envio de telemetria
klauss 69:65665afbad5d 46 extern FILE *ftport; ///< arquivo de Porta UDP do servidor para envio de telemetria
klauss 17:67a6b557eda5 47
klauss 74:81c47fff88a5 48 extern bool flood_silence;
klauss 74:81c47fff88a5 49 extern bool delayed_flood;
klauss 74:81c47fff88a5 50 ///< Variável de controle do envio de pacotes de flood off
klauss 74:81c47fff88a5 51
klauss 69:65665afbad5d 52 /**
klauss 69:65665afbad5d 53 * @Synopsis Principal função de processamento de comandos.
klauss 69:65665afbad5d 54 *
klauss 69:65665afbad5d 55 * \note Apesar de formalmente receber apenas um parâmetro, esta função verifica uma porta TCP para verificar eventual
klauss 69:65665afbad5d 56 * envio de comandos, processando qualquer comando enviado por um usuário ligado na rede.
klauss 69:65665afbad5d 57 *
klauss 69:65665afbad5d 58 * @param ethernet_pkg Uma string de comando que será analisada, caso seja um comando válido, executa-o.
klauss 69:65665afbad5d 59 *
klauss 69:65665afbad5d 60 * @return NULL, sempre retorna NULL.
klauss 69:65665afbad5d 61 *
klauss 69:65665afbad5d 62 * Exemplo:
klauss 69:65665afbad5d 63 * @code
klauss 69:65665afbad5d 64 * ...
klauss 69:65665afbad5d 65 * char * returned_prompt = prompt_process( NULL );
klauss 69:65665afbad5d 66 * ...
klauss 69:65665afbad5d 67 * @endcode
klauss 69:65665afbad5d 68 */
klauss 69:65665afbad5d 69 char * prompt_process( char * ethernet_pkg );
klauss 69:65665afbad5d 70
klauss 69:65665afbad5d 71 /**
klauss 69:65665afbad5d 72 * @Synopsis Init file system and check if files exist
klauss 69:65665afbad5d 73 *
klauss 69:65665afbad5d 74 * Exemplo:
klauss 69:65665afbad5d 75 * @code
klauss 69:65665afbad5d 76 * ...
klauss 69:65665afbad5d 77 * init_fsystem();
klauss 69:65665afbad5d 78 * ...
klauss 69:65665afbad5d 79 * @endcode
klauss 69:65665afbad5d 80 */
klauss 69:65665afbad5d 81 void init_fsystem();
klauss 28:94aec56c6329 82
klauss 69:65665afbad5d 83 /**
klauss 69:65665afbad5d 84 * @Synopsis Inicializa o prompt e os sockets de conexão eth
klauss 69:65665afbad5d 85 *
klauss 69:65665afbad5d 86 * Exemplo:
klauss 69:65665afbad5d 87 * @code
klauss 69:65665afbad5d 88 * ...
klauss 69:65665afbad5d 89 * init_prompt();
klauss 69:65665afbad5d 90 * ...
klauss 69:65665afbad5d 91 * @endcode
klauss 69:65665afbad5d 92 */
klauss 69:65665afbad5d 93 void init_prompt();
klauss 69:65665afbad5d 94
klauss 69:65665afbad5d 95 /**
klauss 69:65665afbad5d 96 * @Synopsis Altera o valor default contido no arquivo /qspi/myip.txt
klauss 69:65665afbad5d 97 *
klauss 69:65665afbad5d 98 * @param new_header_ip Atualiza o valor de /qspi/myip.txt sobrescrevendo-o com o valor de new_header_ip
klauss 69:65665afbad5d 99 *
klauss 69:65665afbad5d 100 * Exemplo:
klauss 69:65665afbad5d 101 * @code
klauss 69:65665afbad5d 102 * ...
klauss 69:65665afbad5d 103 * set_ip( "192.168.120.2" );
klauss 69:65665afbad5d 104 * ...
klauss 69:65665afbad5d 105 * @endcode
klauss 69:65665afbad5d 106 */
klauss 69:65665afbad5d 107 void set_ip( char * new_header_ip );
klauss 28:94aec56c6329 108
klauss 69:65665afbad5d 109 /**
klauss 69:65665afbad5d 110 * @Synopsis Altera o valor default contido no arquivo /qspi/myext.txt
klauss 69:65665afbad5d 111 *
klauss 69:65665afbad5d 112 * @param new_header_ext Atualiza o valor de /qspi/myext.txt sobrescrevendo-o com o valor de new_header_ext
klauss 69:65665afbad5d 113 *
klauss 69:65665afbad5d 114 * Exemplo:
klauss 69:65665afbad5d 115 * @code
klauss 69:65665afbad5d 116 * ...
klauss 69:65665afbad5d 117 * set_header_ext( 912 );
klauss 69:65665afbad5d 118 * ...
klauss 69:65665afbad5d 119 * @endcode
klauss 69:65665afbad5d 120 */
klauss 69:65665afbad5d 121 void set_header_ext( int new_header_ext );
klauss 69:65665afbad5d 122
klauss 69:65665afbad5d 123 /**
klauss 69:65665afbad5d 124 * @Synopsis Altera o valor default contido no arquivo /qspi/mysipport.txt
klauss 69:65665afbad5d 125 *
klauss 69:65665afbad5d 126 * @param new_header_sip_port Atualiza o valor de /qspi/mysipport.txt sobrescrevendo-o com o valor de new_header_sip_port
klauss 69:65665afbad5d 127 *
klauss 69:65665afbad5d 128 * Exemplo:
klauss 69:65665afbad5d 129 * @code
klauss 69:65665afbad5d 130 * ...
klauss 69:65665afbad5d 131 * set_header_sip_port( 820 );
klauss 69:65665afbad5d 132 * ...
klauss 69:65665afbad5d 133 * @endcode
klauss 69:65665afbad5d 134 */
klauss 69:65665afbad5d 135 void set_header_sip_port( int new_header_sip_port );
klauss 28:94aec56c6329 136
klauss 69:65665afbad5d 137 /**
klauss 69:65665afbad5d 138 * @Synopsis Altera o valor default contido no arquivo /qspi/serverip.txt
klauss 69:65665afbad5d 139 *
klauss 69:65665afbad5d 140 * @param new_server_ip Atualiza o valor de /qspi/serverip.txt sobrescrevendo-o com o valor de new_server_ip
klauss 69:65665afbad5d 141 *
klauss 69:65665afbad5d 142 * Exemplo:
klauss 69:65665afbad5d 143 * @code
klauss 69:65665afbad5d 144 * ...
klauss 69:65665afbad5d 145 * set_header_sip_port( "192.168.120.231" );
klauss 69:65665afbad5d 146 * ...
klauss 69:65665afbad5d 147 * @endcode
klauss 69:65665afbad5d 148 */
klauss 69:65665afbad5d 149 void set_server_ip( char * new_server_ip );
klauss 69:65665afbad5d 150
klauss 69:65665afbad5d 151 /**
klauss 69:65665afbad5d 152 * @Synopsis Altera o valor default contido no arquivo /qspi/peerext.txt
klauss 69:65665afbad5d 153 *
klauss 69:65665afbad5d 154 * @param new_server_ext Atualiza o valor de /qspi/peerext.txt sobrescrevendo-o com o valor de new_server_ext
klauss 69:65665afbad5d 155 *
klauss 69:65665afbad5d 156 * Exemplo:
klauss 69:65665afbad5d 157 * @code
klauss 69:65665afbad5d 158 * ...
klauss 69:65665afbad5d 159 * set_header_sip_port( 1011 );
klauss 69:65665afbad5d 160 * ...
klauss 69:65665afbad5d 161 * @endcode
klauss 69:65665afbad5d 162 */
klauss 69:65665afbad5d 163 void set_server_ext( int new_server_ext );
klauss 69:65665afbad5d 164
klauss 69:65665afbad5d 165 /**
klauss 69:65665afbad5d 166 * @Synopsis Altera o valor default contido no arquivo /qspi/serverport.txt
klauss 69:65665afbad5d 167 *
klauss 69:65665afbad5d 168 * @param new_server_port Atualiza o valor de /qspi/serverport.txt sobrescrevendo-o com o valor de new_server_port
klauss 69:65665afbad5d 169 *
klauss 69:65665afbad5d 170 * Exemplo:
klauss 69:65665afbad5d 171 * @code
klauss 69:65665afbad5d 172 * ...
klauss 69:65665afbad5d 173 * set_header_sip_port( 1562 );
klauss 69:65665afbad5d 174 * ...
klauss 69:65665afbad5d 175 * @endcode
klauss 69:65665afbad5d 176 */
klauss 69:65665afbad5d 177 void set_server_port( int new_server_port );
klauss 69:65665afbad5d 178
klauss 69:65665afbad5d 179 /**
klauss 69:65665afbad5d 180 * @Synopsis Altera o valor default contido no arquivo /qspi/udpport.txt
klauss 69:65665afbad5d 181 *
klauss 69:65665afbad5d 182 * @param new_udp_port_listener Atualiza o valor de /qspi/udpport.txt sobrescrevendo-o com o valor de new_udp_port_listener
klauss 69:65665afbad5d 183 *
klauss 69:65665afbad5d 184 * Exemplo:
klauss 69:65665afbad5d 185 * @code
klauss 69:65665afbad5d 186 * ...
klauss 69:65665afbad5d 187 * set_udp_port_listener( 11147 );
klauss 69:65665afbad5d 188 * ...
klauss 69:65665afbad5d 189 * @endcode
klauss 69:65665afbad5d 190 */
klauss 69:65665afbad5d 191 void set_udp_port_listener( int new_udp_port_listener );
klauss 45:c80574f24dc3 192
klauss 69:65665afbad5d 193 /**
klauss 69:65665afbad5d 194 * @Synopsis Altera o valor default contido no arquivo /qspi/tcpport.txt
klauss 69:65665afbad5d 195 *
klauss 69:65665afbad5d 196 * @param new_tcp_port_listener Atualiza o valor de /qspi/tcpport.txt sobrescrevendo-o com o valor de new_tcp_port_listener
klauss 69:65665afbad5d 197 *
klauss 69:65665afbad5d 198 * Exemplo:
klauss 69:65665afbad5d 199 * @code
klauss 69:65665afbad5d 200 * ...
klauss 69:65665afbad5d 201 * set_tcp_port_listener( 7178 );
klauss 69:65665afbad5d 202 * ...
klauss 69:65665afbad5d 203 * @endcode
klauss 69:65665afbad5d 204 */
klauss 56:c64bcbaa621a 205 void set_tcp_port_listener( int new_tcp_port_listener );
klauss 69:65665afbad5d 206
klauss 69:65665afbad5d 207 /**
klauss 69:65665afbad5d 208 * @Synopsis Altera o valor default contido no arquivo /qspi/telemetry_ip.txt
klauss 69:65665afbad5d 209 *
klauss 69:65665afbad5d 210 * @param new_telemetry_ip Atualiza o valor de /qspi/telemetry_ip.txt sobrescrevendo-o com o valor de new_telemetry_ip
klauss 69:65665afbad5d 211 *
klauss 69:65665afbad5d 212 * Exemplo:
klauss 69:65665afbad5d 213 * @code
klauss 69:65665afbad5d 214 * ...
klauss 69:65665afbad5d 215 * set_telemetry_ip( "192.154.123.7" )
klauss 69:65665afbad5d 216 * ...
klauss 69:65665afbad5d 217 * @endcode
klauss 69:65665afbad5d 218 */
klauss 56:c64bcbaa621a 219 void set_telemetry_ip( char * new_telemetry_ip );
klauss 69:65665afbad5d 220
klauss 69:65665afbad5d 221 /**
klauss 69:65665afbad5d 222 * @Synopsis Altera o valor default contido no arquivo /qspi/telemetry_port.txt
klauss 69:65665afbad5d 223 *
klauss 69:65665afbad5d 224 * @param new_telemetry_port Atualiza o valor de /qspi/telemetry_port.txt sobrescrevendo-o com o valor de new_telemetry_port
klauss 69:65665afbad5d 225 *
klauss 69:65665afbad5d 226 * Exemplo:
klauss 69:65665afbad5d 227 * @code
klauss 69:65665afbad5d 228 * ...
klauss 69:65665afbad5d 229 * set_telemetry_port( 9193 );
klauss 69:65665afbad5d 230 * ...
klauss 69:65665afbad5d 231 * @endcode
klauss 69:65665afbad5d 232 */
klauss 56:c64bcbaa621a 233 void set_telemetry_port( int new_telemetry_port );
klauss 69:65665afbad5d 234
klauss 69:65665afbad5d 235 /**
klauss 69:65665afbad5d 236 * @Synopsis Altera o valor default contido no arquivo /qspi/mymask.txt
klauss 69:65665afbad5d 237 *
klauss 69:65665afbad5d 238 * @param new_mask Atualiza o valor de /qspi/mymask.txt sobrescrevendo-o com o valor de new_mask
klauss 69:65665afbad5d 239 *
klauss 69:65665afbad5d 240 * Exemplo:
klauss 69:65665afbad5d 241 * @code
klauss 69:65665afbad5d 242 * ...
klauss 69:65665afbad5d 243 * set_mask( "255.255.0.0" );
klauss 69:65665afbad5d 244 * ...
klauss 69:65665afbad5d 245 * @endcode
klauss 69:65665afbad5d 246 */
klauss 55:2f5e7374af9d 247 void set_mask( char * new_mask );
klauss 69:65665afbad5d 248
klauss 69:65665afbad5d 249 /**
klauss 69:65665afbad5d 250 * @Synopsis Altera o valor default contido no arquivo /qspi/mygate.txt
klauss 69:65665afbad5d 251 *
klauss 69:65665afbad5d 252 * @param new_gateway Atualiza o valor de /qspi/mygate.txt sobrescrevendo-o com o valor de new_gateway
klauss 69:65665afbad5d 253 *
klauss 69:65665afbad5d 254 * Exemplo:
klauss 69:65665afbad5d 255 * @code
klauss 69:65665afbad5d 256 * ...
klauss 69:65665afbad5d 257 * set_gateway( "192.168.118.2" );
klauss 69:65665afbad5d 258 * ...
klauss 69:65665afbad5d 259 * @endcode
klauss 69:65665afbad5d 260 */
klauss 55:2f5e7374af9d 261 void set_gateway( char * new_gateway );
klauss 17:67a6b557eda5 262
klauss 44:cc4996469404 263 extern char * debug_buf;
klauss 69:65665afbad5d 264 ///< Buffer de entrada dos dados via serial.
klauss 17:67a6b557eda5 265
klauss 50:d9b6577a70f5 266
klauss 17:67a6b557eda5 267 #endif