tkdnip.h

説明を見る。

/*******************************************************************************
* RXduinoライブラリ & 特電HAL
* 
* このソフトウェアは特殊電子回路株式会社によって開発されたものです。
* 当社Webサイトを通じてダウンロードすることによって使用許諾されます。
* このファイルを第三者へ開示・再配布・貸与・譲渡することはできません。
* このソフトウェアはあるがままの状態で提供され、内容および動作についての保障はあ
* りません。弊社はファイルの内容および実行結果についていかなる責任も負いません。
* お客様は、お客様の製品開発のために当ソフトウェアのソースコードを自由に参照し、
* 引用していただくことができます。
* コンパイル・リンク後のオブジェクトファイル(ELF ファイルまたはMOT,SRECファイル)
* であって、デバッグ情報が削除されている場合は第三者に再配布することができます。
* (C) Copyright 2011-2014 TokushuDenshiKairo Inc. 特殊電子回路株式会社
* http://rx.tokudenkairo.co.jp/
*******************************************************************************/

#ifndef H_TKDNIP
#define H_TKDNIP
/**************************************************************************/
// 特電HAL
#include "tkdn_hal.h"

#ifndef BOOL
 #define BOOL  int
#endif

#ifdef __cplusplus
    extern "C" {
#endif

/*********************************************************************/
typedef enum {
    LINK_DOWN         = 0, 
    LINK_UP           = 1, 
    LINK_DOWN_CHANGED = 2, 
    LINK_UP_CHANGED   = 3  
} LINK_STATE;


/*********************************************************************/
typedef enum {
    DNS_NONAUTH,   
    DNS_AUTH,      
    DNS_APPENDIX,  
    DNS_UNDEF      
} DNS_REPLY_TYPE;

/*********************************************************************/
typedef enum {
    
    DNS_A     = 1,   
    DNS_NS    = 2,   
    DNS_CNAME = 5,   
    DNS_PTR   = 12,  
    DNS_MX    = 15,  
    DNS_AAAA  = 28,  
    DNS_ANY   = 255, 
} DNS_TYPE;

/*********************************************************************/
typedef enum {
    DNS_UNKN  = 0, 
    DNS_IN    = 1, 
} DNS_CLASS;

/****************************************************************
* @brief   DNSの結果レコードが格納される構造体。
* @details dns_records_t 型に含まれるフィールドで用いられる
*          ユーザアプリで詳細なDNS情報を使う場合に使用する。
****************************************************************/
typedef struct dns_record_t
{
    DNS_REPLY_TYPE rtype;  
    DNS_TYPE       type;   
    DNS_CLASS      aclass; 
    int            ttl;    
    char           *name;  
    unsigned char  *data;  
} dns_record_t;


/****************************************************************
* @brief   DNSの結果が格納される構造体 dns_record_t の配列を格納するための構造体
* @details tketh_nslookup_ex() の戻り値で使われる
* @note    この構造体が不要になったときには、 tketh_free_dns_records() で開放すること。
****************************************************************/
typedef struct dns_records_t
{
    int             num_of_records; 
    dns_record_t  **record;         
} dns_records_t;

/****************************************************************
* @def        UDP_HANDLE_FUNC
* @brief   UDPを受信したときに呼び出されるユーザ関数
* @details この関数がTRUEを返すとユーザで処理したものと解釈され、システムでは処理されない。<BR>
*          この関数がFALSEを返すとシステムでは処理される。<BR>
* @note    この関数が呼び出されるとき、ポート番号とデータ長はリトルエンディアンになっている<BR>
****************************************************************/
typedef BOOL (*UDP_HANDLE_FUNC)(
    unsigned char dest_ip[4],
    unsigned char src_ip[4],
    unsigned short dest_port,
    unsigned short src_port,
    unsigned char *data, // UDPパケットのデータ部
    short datalen        // UDPパケットのデータの長さ(ヘッダは含まない)
);

typedef struct tcp_str tcp_t;
typedef struct tcp_server_str tcp_server_t;

typedef enum {
      TCP_CLOSED,    
      TCP_LISTEN,    
      TCP_SYNRCVD,   
      TCP_ESTAB,     
      TCP_FIN_WAIT1, 
      TCP_FIN_WAIT2, 
      TCP_CLOSING,   
      TCP_TIME_WAIT, 
      TCP_SYN_SENT,  
      TCP_CLOSEWAIT, 
      TCP_LAST_ACK   
} TCP_STATE;

// クライアントの接続状態を示す構造体。 clients_stat_t のメンバとして使われる
typedef struct client_stat_t
{
    unsigned char  ipaddr[4];    // @brief クライアントIPアドレス
    unsigned short local_port;   // @brief ローカルポート番号
    unsigned short foreign_port; // @brief 相手先ポート番号
    BOOL           server;       // @brief 自分がサーバかどうか
    TCP_STATE      state;        // @brief TCPの状態
} client_stat_t;

// クライアントの接続状態を示す構造体のリスト。 tketh_get_client_stats() の結果として返される。
typedef struct clients_stat_t
{
    int             num_of_clients; // 接続しているクライアントの数
    client_stat_t  *clients;        // 接続クライアント情報
} clients_stat_t;

typedef void (*FUNCTYPE_TCPEVENT)(tcp_t *client);

//                         ユーザ公開関数

//------------------------------------------------------------------------
// 基本的な操作
//------------------------------------------------------------------------

/*********************************************************************/
void tketh_open(unsigned char *macaddr);

/*********************************************************************/
LINK_STATE tketh_check_link();

/*********************************************************************/
void tketh_process();

/*********************************************************************/
void tketh_debug(int level);

/*********************************************************************/
void tketh_set_hostname(const char *hostname);

/*********************************************************************/
char *tketh_get_hostname(void);

/*********************************************************************/
void tketh_change_macaddr(const unsigned char macaddr[6]);

/*********************************************************************/
void tketh_get_macaddr(unsigned char macaddr[6]);

//------------------------------------------------------------------------
// IPアドレス等の設定や取得
//------------------------------------------------------------------------

/*********************************************************************/
BOOL tketh_dhcpc(void);

/*********************************************************************/
void tketh_set_myipaddr(unsigned char ipaddr[4],unsigned char mask[4]);

/*********************************************************************/
void tketh_get_myipaddr(unsigned char ipaddr[4],unsigned char mask[4]);

/*********************************************************************/
void tketh_set_gateway(unsigned char ipaddr[4]);

/*********************************************************************/
void tketh_get_gateway(unsigned char ipaddr[4]);

/*********************************************************************/
void tketh_set_nameserver(unsigned char ipaddr[4]);

/*********************************************************************/
void tketh_get_nameserver(unsigned char ipaddr[4]);

/*********************************************************************/
void tketh_arp_table_show();

//------------------------------------------------------------------------
// 低レベルなパケットの送受信
//------------------------------------------------------------------------

/*********************************************************************/
BOOL tketh_send_udp(unsigned char tgtaddr[4],unsigned short dest_port,unsigned short src_port,unsigned char *buf,int len);

/*********************************************************************/
void tketh_regist_udp_handler(UDP_HANDLE_FUNC func);

//------------------------------------------------------------------------
// PING関係のプロトコル
//------------------------------------------------------------------------

/*********************************************************************/
BOOL tketh_send_ping(unsigned char ipaddr[4],unsigned char *buf,int len);

/*********************************************************************/
BOOL tketh_is_ping_running();

/*********************************************************************/
void tketh_cancel_ping();

/*********************************************************************/
unsigned long tketh_ping_starttime();

//------------------------------------------------------------------------
// 名前解決
//------------------------------------------------------------------------

/*********************************************************************/
BOOL tketh_nslookup(char *hostname,unsigned char ipaddr[4]);

/*********************************************************************/
dns_records_t *tketh_nslookup_ex(char *hostname);

/*********************************************************************/
void tketh_free_dns_records(dns_records_t *dnsrec);

/*********************************************************************/
BOOL tketh_ip_to_hostname(unsigned char ipaddr[4],char *hostname,int hostname_maxlen);

//------------------------------------------------------------------------
// TCPクライアント
//------------------------------------------------------------------------

/*********************************************************************/
tcp_t *tketh_tcp_connect(unsigned char ipaddr[4],unsigned short dest_port);

/*********************************************************************/
BOOL tketh_tcp_is_connected(tcp_t *info);

/*********************************************************************/
void tketh_tcp_fin(tcp_t *info);

/*********************************************************************/
char *tketh_tcp_state(tcp_t *info);

/*********************************************************************/
void tketh_tcp_senddata(tcp_t *info,unsigned char *data,int len);

/*********************************************************************/
int tketh_tcp_recvcount(tcp_t *info);

/*********************************************************************/
int tketh_tcp_recvdata(tcp_t *info,unsigned char *data,int len);

//------------------------------------------------------------------------
// TCPサーバ ※現在はセッションを１つしか張れない
//------------------------------------------------------------------------

/*********************************************************************/
tcp_t *tketh_tcp_open_server(unsigned short port,FUNCTYPE_TCPEVENT func);

/*********************************************************************/
BOOL tketh_tcp_listen(tcp_t *info);

/*********************************************************************/
unsigned char *tketh_tcp_target_addr(tcp_t *info);

/*********************************************************************/
void tketh_tcp_server_terminate(tcp_t *info);

//------------------------------------------------------------------------
// コネクション管理
//------------------------------------------------------------------------

/*********************************************************************/
clients_stat_t *tketh_get_client_stats();

/*********************************************************************/
void tketh_tcp_set_rbuf_length(unsigned short len);

void tketh_debug_push(int len,unsigned char *buf,int isSend);
BOOL tketh_debug_pop(int *len,unsigned char *buf,int *isSend);
int  tketh_debug_count();
void tketh_debug_ethpacket(int len,char *buf,int isSend);
void packet_dump(unsigned char *buf,int len,int isSend);

#ifdef __cplusplus
    }
#endif

#endif