Ryo Iizuka / libMiMic

This is Webservice SDK for mbed. LPCXpresso1769/LPC1768/FRDM-K64F/LPC4088

Dependents:   MbedFileServer_1768MiniDK2 RedWireBridge IssueDebug_gcc MiMicRemoteMCU-for-Mbed ... more

libMiMic(MiMic library for mbed)は、WebService機能を提供するSDKです。 mbedでWebAPIに対応したネットワークデバイスを簡単に作ることが出来ます。

libMiMicはMiMic projectで開発しています。MiMic projectについてはこちらをご覧ください。 http://nyatla.jp/mimic/wp/

構成

libMiMicはmbedRTOS上で動作し、ユーザアプリケーションにAPIを提供します。コアAPIはC言語で記述されていますが、使用頻度の高いものについてはmbed向けのC++APIが準備されています。

/media/uploads/nyatla/libmimic-sdk.png

※libMiMicはmbedの標準イーサネットドライバをしようしていません。

標準イーサネットドライバと同時に使用することはできません。

  • MiMicIP - IPv4スタックです。レテンシとメモリ消費量を抑えたuipベースのライブラリです。
  • ARP/ICMP/UDP/TCP - 基礎的なソケットAPIを提供します。APIは独自です。
  • HTTP/1.1 Server - HTTP/1.1に対応したサーバです。マルチセッション・Chunked・持続性接続に対応しています。
  • HTTP Modules - HTTP/1.1の機能モジュールです。以下のモジュールがあります。
    • ROM file provider - ROMに格納したファイルイメージを公開します。
    • File system provider - mbedファイルシステムを公開します。
    • Onchip configuration - プログラムフラッシュを利用して設定を保存します。
    • MiMicVM processor - RPCリクエスト(MiMicVM)を処理します。
    • FileUpload - ファイルアップロードを受け取ります。
    • URL decoder - HTTPリクエストを解析します。
    • UPnP handler -UPnPメッセージを処理します。
    • WebSocket - Websocketサーバです。
  • mDNS - マルチキャストDNSサービスです。
  • UPnP - UPnP/1.0の機能を提供します。UPnP handlerと協調して動作します。(現在はデバイス探索(SSDP)・デスクリプション(Description)のみ実装してあります。)
  • DHCP/APIPA - ゼロコンフィギュレーション用のモジュールです。
  • HTTP/1.1 Client
  • mbed C++ class library - mbed向けのC++CPIです。C言語のものより簡単です。

対応機種

  • mbed(mbed LPC1768)
  • LPCXpresso1769

プログラム

Import programMiMicRemoteMCU-for-Mbed

MiMic RemoteMCU for mbed. This program provides MCU control API over REST API. It can control MCU from Javascript,PHP or any HTTP rest client directly. And, The application has self development environment.

Last commit 30 May 2014 by Ryo Iizuka

Import programMbedFileServer

The program publishes files at local directory and SD filesystem. It is a full-fledged webServer somewhat.

Last commit 15 Sep 2015 by Ryo Iizuka

サンプル

Import programMiMicSimpleHttpd

This is a simplest HTTP server made ​​of libMiMic. It will echo back a request path.

Last commit 15 Sep 2015 by Ryo Iizuka

Import programUPnPBasicDevice

Simplest UPnP basic device example. This program to run UPnP basic device on the mbed.

Last commit 15 Sep 2015 by Ryo Iizuka

Import programWebSocketSample

MiMicSDK Websocket module sample program.

Last commit 15 Sep 2015 by Ryo Iizuka

Import programHttpClientSamlpe

A http client sample program.

Last commit 15 Sep 2015 by Ryo Iizuka

Import programTcpSocketClientSamlpe

MiMicSDK Tcp client socket sample program.

Last commit 15 Sep 2015 by Ryo Iizuka

Import programUdpSocketSamlpe

Udp socket sample program. This program will send back the received packet.

Last commit 15 Sep 2015 by Ryo Iizuka

チュートリアル

English

libMiMic(MiMic library for mbed) is SDK which provides Webservice functions. It can be created networking device easily using mbed.

See more MiMic information, See MiMic project website. http://nyatla.jp/mimic/wp/

Structure

libMiMic run on mbed RTOS and provides networking API to user application. This library has C++ class API for the mbed, and low-level C language API.

/media/uploads/nyatla/libmimic-sdk.png

For WebService general, it can be written in a simple C + + API.

libMiMic does not have the standard Ethernet driver of mbed.　It is not possible that will be used with the standard Ethernet driver.

  • MiMicIP - IPv4 protocol stack. This is based uip which is reduced memory and latency.
  • ARP / ICMP / UDP / TCP - Those are provide basic IP protocols.
  • HTTP/1.1 Server - The Http server compatible HTTP/1.1. It supports multi-session, chunked transport, persistent connection.
  • HTTP Modules - There are addon-module for HTTP server. The following modules.
    • ROM file module - Publish the file images in ROM.
    • File system module - Publish thefiles in mbed file system.
    • Onchip configuration module - To save the network settings to the program flash via REST.
    • MiMicVM module - To handle the (MiMicVM) RPC request.
    • FileUpload module - Accept a file via HTTP POST.
    • URL dedoce module - A versatility URL decoder.
    • UPnP handle module - To handle UPnP messages.
    • UPnP - This provides UPnP/1.0 device functions. It works together with UPnP handler.
    • Websocket - websocket (version13) server
  • mDNS Service - DNS-SD protocol server.
  • UPnP - This provides UPnP/1.0 device functions which works with UPnP handler. (You have been implemented (SSDP) ? description only (Description) device search now.) It is a module zero configuration for - DHCP / APIPA. mbed C + + class library - C of mbed for + + is the CPI. It is simple than that of the C language.
  • DHCP/APIPA - It support zero-cpnfigulation.
  • mbed C++ class library. Almost APIs for Web applications are available.
  • HTTP/1.1 Client

Supported target

  • mbed(mbed LPC1768)
  • LPCXpresso1769

Application

Import programMiMicRemoteMCU-for-Mbed

MiMic RemoteMCU for mbed. This program provides MCU control API over REST API. It can control MCU from Javascript,PHP or any HTTP rest client directly. And, The application has self development environment.

Last commit 30 May 2014 by Ryo Iizuka

Import programMbedFileServer

The program publishes files at local directory and SD filesystem. It is a full-fledged webServer somewhat.

Last commit 15 Sep 2015 by Ryo Iizuka

Sample

Import programMiMicSimpleHttpd

This is a simplest HTTP server made ​​of libMiMic. It will echo back a request path.

Last commit 15 Sep 2015 by Ryo Iizuka

Import programUPnPBasicDevice

Simplest UPnP basic device example. This program to run UPnP basic device on the mbed.

Last commit 15 Sep 2015 by Ryo Iizuka

Import programWebSocketSample

MiMicSDK Websocket module sample program.

Last commit 15 Sep 2015 by Ryo Iizuka

Import programHttpClientSamlpe

A http client sample program.

Last commit 15 Sep 2015 by Ryo Iizuka

Import programTcpSocketClientSamlpe

MiMicSDK Tcp client socket sample program.

Last commit 15 Sep 2015 by Ryo Iizuka

Import programUdpSocketSamlpe

Udp socket sample program. This program will send back the received packet.

Last commit 15 Sep 2015 by Ryo Iizuka

Tutorial

core/netif/NyLPC_NetIf_ip_types.h@109:18f12ac01097, 2014-11-19 (annotated)

Committer:
nyatla
Date:
Wed Nov 19 14:45:17 2014 +0000
Revision:
109:18f12ac01097
new MiMicIP API;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
nyatla 109:18f12ac01097 1 /*********************************************************************************
nyatla 109:18f12ac01097 2 * PROJECT: MiMic
nyatla 109:18f12ac01097 3 * --------------------------------------------------------------------------------
nyatla 109:18f12ac01097 4 *
nyatla 109:18f12ac01097 5 * This file is part of MiMic
nyatla 109:18f12ac01097 6 * Copyright (C)2011 Ryo Iizuka
nyatla 109:18f12ac01097 7 *
nyatla 109:18f12ac01097 8 * MiMic is free software: you can redistribute it and/or modify
nyatla 109:18f12ac01097 9 * it under the terms of the GNU Lesser General Public License as published
nyatla 109:18f12ac01097 10 * by　the Free Software Foundation, either version 3 of the　License, or
nyatla 109:18f12ac01097 11 * (at your option) any later version.
nyatla 109:18f12ac01097 12 *
nyatla 109:18f12ac01097 13 * This program is distributed in the hope that it will be useful,
nyatla 109:18f12ac01097 14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
nyatla 109:18f12ac01097 15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
nyatla 109:18f12ac01097 16 * GNU General Public License for more details.
nyatla 109:18f12ac01097 17 *
nyatla 109:18f12ac01097 18 * You should have received a copy of the GNU Lesser General Public License
nyatla 109:18f12ac01097 19 * along with this program. If not, see <http://www.gnu.org/licenses/>.
nyatla 109:18f12ac01097 20 *
nyatla 109:18f12ac01097 21 * For further information please contact.
nyatla 109:18f12ac01097 22 * http://nyatla.jp/
nyatla 109:18f12ac01097 23 * <airmail(at)ebony.plala.or.jp> or <nyatla(at)nyatla.jp>
nyatla 109:18f12ac01097 24 *
nyatla 109:18f12ac01097 25 *
nyatla 109:18f12ac01097 26 * Parts of this file were leveraged from uIP:
nyatla 109:18f12ac01097 27 *
nyatla 109:18f12ac01097 28 * Copyright (c) 2001-2003, Adam Dunkels.
nyatla 109:18f12ac01097 29 * All rights reserved.
nyatla 109:18f12ac01097 30 *
nyatla 109:18f12ac01097 31 * Redistribution and use in source and binary forms, with or without
nyatla 109:18f12ac01097 32 * modification, are permitted provided that the following conditions
nyatla 109:18f12ac01097 33 * are met:
nyatla 109:18f12ac01097 34 * 1. Redistributions of source code must retain the above copyright
nyatla 109:18f12ac01097 35 * notice, this list of conditions and the following disclaimer.
nyatla 109:18f12ac01097 36 * 2. Redistributions in binary form must reproduce the above copyright
nyatla 109:18f12ac01097 37 * notice, this list of conditions and the following disclaimer in the
nyatla 109:18f12ac01097 38 * documentation and/or other materials provided with the distribution.
nyatla 109:18f12ac01097 39 * 3. The name of the author may not be used to endorse or promote
nyatla 109:18f12ac01097 40 * products derived from this software without specific prior
nyatla 109:18f12ac01097 41 * written permission.
nyatla 109:18f12ac01097 42 *
nyatla 109:18f12ac01097 43 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
nyatla 109:18f12ac01097 44 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
nyatla 109:18f12ac01097 45 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
nyatla 109:18f12ac01097 46 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
nyatla 109:18f12ac01097 47 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
nyatla 109:18f12ac01097 48 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
nyatla 109:18f12ac01097 49 * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
nyatla 109:18f12ac01097 50 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
nyatla 109:18f12ac01097 51 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
nyatla 109:18f12ac01097 52 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
nyatla 109:18f12ac01097 53 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
nyatla 109:18f12ac01097 54 */
nyatla 109:18f12ac01097 55 #ifndef NyLPC_NETIF_IP_TYPES_h
nyatla 109:18f12ac01097 56 #define NyLPC_NETIF_IP_TYPES_h
nyatla 109:18f12ac01097 57 #include "NyLPC_config.h"
nyatla 109:18f12ac01097 58 #include "NyLPC_stdlib.h"
nyatla 109:18f12ac01097 59 #include "NyLPC_NetIf_ethernet_types.h"
nyatla 109:18f12ac01097 60 #include "NyLPC_NetIf_ip_types.h"
nyatla 109:18f12ac01097 61
nyatla 109:18f12ac01097 62 #ifdef __cplusplus
nyatla 109:18f12ac01097 63 extern "C" {
nyatla 109:18f12ac01097 64 #endif /* __cplusplus */
nyatla 109:18f12ac01097 65
nyatla 109:18f12ac01097 66 #define UIP_PROTO_ICMP 1
nyatla 109:18f12ac01097 67 #define UIP_PROTO_TCP 6
nyatla 109:18f12ac01097 68 #define UIP_PROTO_UDP 17
nyatla 109:18f12ac01097 69 #define UIP_PROTO_ICMP6 58
nyatla 109:18f12ac01097 70
nyatla 109:18f12ac01097 71 #define ARP_REQUEST 1
nyatla 109:18f12ac01097 72 #define ARP_REPLY 2
nyatla 109:18f12ac01097 73 #define ARP_HWTYPE_ETH 1
nyatla 109:18f12ac01097 74
nyatla 109:18f12ac01097 75 /**　イーサネットヘッダのサイズ値*/
nyatla 109:18f12ac01097 76 #define UIP_ETHERHEADER_LEN 14
nyatla 109:18f12ac01097 77 #define UIP_TCPH_LEN 20 /* Size of TCP header */
nyatla 109:18f12ac01097 78 #define UIP_IPH_LEN 20 /* Size of IP header */
nyatla 109:18f12ac01097 79
nyatla 109:18f12ac01097 80 #ifndef PACK_STRUCT_END
nyatla 109:18f12ac01097 81 #define PACK_STRUCT_END __attribute((packed))
nyatla 109:18f12ac01097 82 #endif
nyatla 109:18f12ac01097 83
nyatla 109:18f12ac01097 84 /**********************************************************************
nyatla 109:18f12ac01097 85 *
nyatla 109:18f12ac01097 86 *
nyatla 109:18f12ac01097 87 *
nyatla 109:18f12ac01097 88 **********************************************************************/
nyatla 109:18f12ac01097 89
nyatla 109:18f12ac01097 90 /**
nyatla 109:18f12ac01097 91 * IPアドレスを格納します。
nyatla 109:18f12ac01097 92 * IPアドレスは、ネットワークオーダーで設定します。
nyatla 109:18f12ac01097 93 */
nyatla 109:18f12ac01097 94 struct NyLPC_TIPv4Addr
nyatla 109:18f12ac01097 95 {
nyatla 109:18f12ac01097 96 NyLPC_TUInt32 v;
nyatla 109:18f12ac01097 97 }PACK_STRUCT_END;
nyatla 109:18f12ac01097 98 extern const struct NyLPC_TIPv4Addr NyLPC_TIPv4Addr_ZERO;
nyatla 109:18f12ac01097 99 extern const struct NyLPC_TIPv4Addr NyLPC_TIPv4Addr_ALL;
nyatla 109:18f12ac01097 100 extern const struct NyLPC_TIPv4Addr NyLPC_TIPv4Addr_BROADCAST;
nyatla 109:18f12ac01097 101 extern const struct NyLPC_TIPv4Addr NyLPC_TIPv4Addr_MULTICAST;
nyatla 109:18f12ac01097 102 extern const struct NyLPC_TIPv4Addr NyLPC_TIPv4Addr_MULTICAST_MASK;
nyatla 109:18f12ac01097 103 extern const struct NyLPC_TIPv4Addr NyLPC_TIPv4Addr_APIPA_MASK;
nyatla 109:18f12ac01097 104
nyatla 109:18f12ac01097 105 /**
nyatla 109:18f12ac01097 106 * addr1とaddr2が全く同じであるかをテストします。
nyatla 109:18f12ac01097 107 * \hideinitializer
nyatla 109:18f12ac01097 108 */
nyatla 109:18f12ac01097 109 #define NyLPC_TIPv4Addr_isEqual(v1,v2) ((v1)->v==(v2)->v)
nyatla 109:18f12ac01097 110 /**
nyatla 109:18f12ac01097 111 * addr1とaddr2をmaskでマスクした結果を比較します。
nyatla 109:18f12ac01097 112 * \hideinitializer
nyatla 109:18f12ac01097 113 */
nyatla 109:18f12ac01097 114 #define NyLPC_TIPv4Addr_isEqualWithMask(addr1, addr2, mask) ((((addr1)->v) & ((mask)->v))==(((addr2)->v) & ((mask)->v)))
nyatla 109:18f12ac01097 115
nyatla 109:18f12ac01097 116 /**
nyatla 109:18f12ac01097 117 * 変数にIP v4アドレスをセットします。
nyatla 109:18f12ac01097 118 * 次のように使います。
nyatla 109:18f12ac01097 119 \code
nyatla 109:18f12ac01097 120 NyLPC_TIPv4Addr ip;
nyatla 109:18f12ac01097 121 NyLPC_TIpv4Addr_set(&ip,1,2,3,4);
nyatla 109:18f12ac01097 122 \endcode
nyatla 109:18f12ac01097 123 */
nyatla 109:18f12ac01097 124 #define NyLPC_TIPv4Addr_set(s,a0,a1,a2,a3) (s)->v=NyLPC_htonl((0xff000000&(((NyLPC_TUInt32)(a0))<<24))|(0x00ff0000&(((NyLPC_TUInt32)(a1))<<16))|(0x0000ff00&(((NyLPC_TUInt32)(a2))<<8))|(0x000000ff&((NyLPC_TUInt32)(a3))))
nyatla 109:18f12ac01097 125 #define NyLPC_TIPv4Addr_pack(a0,a1,a2,a3) {NyLPC_HTONL((0xff000000&(((NyLPC_TUInt32)(a0))<<24))|(0x00ff0000&(((NyLPC_TUInt32)(a1))<<16))|(0x0000ff00&(((NyLPC_TUInt32)(a2))<<8))|(0x000000ff&((NyLPC_TUInt32)(a3))))}
nyatla 109:18f12ac01097 126
nyatla 109:18f12ac01097 127 /**
nyatla 109:18f12ac01097 128 * IPアドレスを文字列に変換して返します。
nyatla 109:18f12ac01097 129 */
nyatla 109:18f12ac01097 130 NyLPC_TInt16 NyLPC_TIPv4Addr_toString(const struct NyLPC_TIPv4Addr* i_ip,NyLPC_TChar* i_buf);
nyatla 109:18f12ac01097 131
nyatla 109:18f12ac01097 132
nyatla 109:18f12ac01097 133
nyatla 109:18f12ac01097 134
nyatla 109:18f12ac01097 135
nyatla 109:18f12ac01097 136 struct uip_ip6addr
nyatla 109:18f12ac01097 137 {
nyatla 109:18f12ac01097 138 NyLPC_TUInt16 v[8];
nyatla 109:18f12ac01097 139 }PACK_STRUCT_END;
nyatla 109:18f12ac01097 140
nyatla 109:18f12ac01097 141 typedef struct uip_ip6addr uip_ip6addr_t;
nyatla 109:18f12ac01097 142
nyatla 109:18f12ac01097 143 NyLPC_TUInt16 NyLPC_uip_chksum(NyLPC_TUInt16 sum, const NyLPC_TUInt8 *data, NyLPC_TUInt16 len);
nyatla 109:18f12ac01097 144
nyatla 109:18f12ac01097 145
nyatla 109:18f12ac01097 146
nyatla 109:18f12ac01097 147
nyatla 109:18f12ac01097 148 /**
nyatla 109:18f12ac01097 149 * TTL
nyatla 109:18f12ac01097 150 */
nyatla 109:18f12ac01097 151 #define UIP_DEFAULT_IP_TTL 64
nyatla 109:18f12ac01097 152
nyatla 109:18f12ac01097 153
nyatla 109:18f12ac01097 154
nyatla 109:18f12ac01097 155 /**
nyatla 109:18f12ac01097 156 * The maximum number of times a segment should be retransmitted
nyatla 109:18f12ac01097 157 * before the connection should be aborted.
nyatla 109:18f12ac01097 158 *
nyatla 109:18f12ac01097 159 * This should not be changed.
nyatla 109:18f12ac01097 160 */
nyatla 109:18f12ac01097 161 #define UIP_MAXRTX 8
nyatla 109:18f12ac01097 162
nyatla 109:18f12ac01097 163
nyatla 109:18f12ac01097 164
nyatla 109:18f12ac01097 165
nyatla 109:18f12ac01097 166
nyatla 109:18f12ac01097 167 # if UIP_BYTE_ORDER == NyLPC_ENDIAN_BIG
nyatla 109:18f12ac01097 168 # define NyLPC_HTONS(n) (n)
nyatla 109:18f12ac01097 169 # define NyLPC_htons(n) (n)
nyatla 109:18f12ac01097 170 # define NyLPC_ntohs(n) (n)
nyatla 109:18f12ac01097 171 # define NyLPC_htonl(n) (n)
nyatla 109:18f12ac01097 172 # define NyLPC_ntohl(n) (n)
nyatla 109:18f12ac01097 173 # define NyLPC_HTONS(n) (n)
nyatla 109:18f12ac01097 174 # define NyLPC_NTOHS(n) (n)
nyatla 109:18f12ac01097 175 # else
nyatla 109:18f12ac01097 176 # define NyLPC_htonl(n) NyLPC_TUInt32_bswap(n)
nyatla 109:18f12ac01097 177 # define NyLPC_ntohl(n) NyLPC_TUInt32_bswap(n)
nyatla 109:18f12ac01097 178 # define NyLPC_htons(n) NyLPC_TUInt16_bswap(n)
nyatla 109:18f12ac01097 179 # define NyLPC_ntohs(n) NyLPC_TUInt16_bswap(n)
nyatla 109:18f12ac01097 180 # define NyLPC_HTONS(n) NyLPC_TUInt16_BSWAP(n)
nyatla 109:18f12ac01097 181 # define NyLPC_NTOHS(n) NyLPC_TUInt16_BSWAP(n)
nyatla 109:18f12ac01097 182 # define NyLPC_NTOHL(n) NyLPC_TUInt32_BSWAP(n)
nyatla 109:18f12ac01097 183 # define NyLPC_HTONL(n) NyLPC_TUInt32_BSWAP(n)
nyatla 109:18f12ac01097 184 #endif /* NyLPC_HTONS */
nyatla 109:18f12ac01097 185
nyatla 109:18f12ac01097 186
nyatla 109:18f12ac01097 187
nyatla 109:18f12ac01097 188
nyatla 109:18f12ac01097 189 /**********************************************************************
nyatla 109:18f12ac01097 190 *
nyatla 109:18f12ac01097 191 * struct NyLPC_TEthernetIIHeader
nyatla 109:18f12ac01097 192 *
nyatla 109:18f12ac01097 193 **********************************************************************/
nyatla 109:18f12ac01097 194
nyatla 109:18f12ac01097 195 #define NyLPC_TEthernetIIHeader_TYPE_IP 0x0800
nyatla 109:18f12ac01097 196 #define NyLPC_TEthernetIIHeader_TYPE_ARP 0x0806
nyatla 109:18f12ac01097 197 #define NyLPC_TEthernetIIHeader_TYPE_IPV6 0x86DD
nyatla 109:18f12ac01097 198 //#define UIP_ETHTYPE_IP 0x0800
nyatla 109:18f12ac01097 199 //#define UIP_ETHTYPE_ARP 0x0806
nyatla 109:18f12ac01097 200 //#define UIP_ETHTYPE_IP6 0x86dd
nyatla 109:18f12ac01097 201
nyatla 109:18f12ac01097 202 struct NyLPC_TEthernetIIHeader
nyatla 109:18f12ac01097 203 {
nyatla 109:18f12ac01097 204 struct NyLPC_TEthAddr dest;
nyatla 109:18f12ac01097 205 struct NyLPC_TEthAddr src;
nyatla 109:18f12ac01097 206 NyLPC_TUInt16 type;
nyatla 109:18f12ac01097 207 }PACK_STRUCT_END;
nyatla 109:18f12ac01097 208
nyatla 109:18f12ac01097 209
nyatla 109:18f12ac01097 210 NyLPC_TUInt16 NyLPC_TEthernetIIHeader_setArpTx(
nyatla 109:18f12ac01097 211 struct NyLPC_TEthernetIIHeader* i_struct,
nyatla 109:18f12ac01097 212 const struct NyLPC_TEthAddr* i_my_eth_addr);
nyatla 109:18f12ac01097 213
nyatla 109:18f12ac01097 214 NyLPC_TUInt16 NyLPC_TEthernetIIHeader_setIPv4Tx(
nyatla 109:18f12ac01097 215 struct NyLPC_TEthernetIIHeader* i_eth,
nyatla 109:18f12ac01097 216 const struct NyLPC_TEthAddr* i_src_eth_addr,
nyatla 109:18f12ac01097 217 const struct NyLPC_TEthAddr* i_dest_eth_addr);
nyatla 109:18f12ac01097 218 /**********************************************************************
nyatla 109:18f12ac01097 219 *
nyatla 109:18f12ac01097 220 * struct NyLPC_TIPv4Header
nyatla 109:18f12ac01097 221 *
nyatla 109:18f12ac01097 222 **********************************************************************/
nyatla 109:18f12ac01097 223
nyatla 109:18f12ac01097 224
nyatla 109:18f12ac01097 225 /**
nyatla 109:18f12ac01097 226 * IPパケットヘッダのメモリマップ構造体
nyatla 109:18f12ac01097 227 * 値はすべてネットワークオーダーです。
nyatla 109:18f12ac01097 228 */
nyatla 109:18f12ac01097 229 struct NyLPC_TIPv4Header
nyatla 109:18f12ac01097 230 {
nyatla 109:18f12ac01097 231 NyLPC_TUInt8 vhl;
nyatla 109:18f12ac01097 232 NyLPC_TUInt8 tos;
nyatla 109:18f12ac01097 233 NyLPC_TUInt16 len16;
nyatla 109:18f12ac01097 234 NyLPC_TUInt16 ipid16;
nyatla 109:18f12ac01097 235 NyLPC_TUInt16 ipoffset;
nyatla 109:18f12ac01097 236 NyLPC_TUInt8 ttl;
nyatla 109:18f12ac01097 237 NyLPC_TUInt8 proto;
nyatla 109:18f12ac01097 238 NyLPC_TUInt16 ipchksum;
nyatla 109:18f12ac01097 239 struct NyLPC_TIPv4Addr srcipaddr;
nyatla 109:18f12ac01097 240 struct NyLPC_TIPv4Addr destipaddr;
nyatla 109:18f12ac01097 241 }PACK_STRUCT_END;
nyatla 109:18f12ac01097 242
nyatla 109:18f12ac01097 243
nyatla 109:18f12ac01097 244
nyatla 109:18f12ac01097 245
nyatla 109:18f12ac01097 246 NyLPC_TBool NyLPC_TIPv4Header_isCorrectIpCheckSum(
nyatla 109:18f12ac01097 247 const struct NyLPC_TIPv4Header* ip_header);
nyatla 109:18f12ac01097 248
nyatla 109:18f12ac01097 249 NyLPC_TBool NyLPC_cIPv4Packet_isCorrectTcpCheckSum(
nyatla 109:18f12ac01097 250 const struct NyLPC_TIPv4Header* ip_header);
nyatla 109:18f12ac01097 251
nyatla 109:18f12ac01097 252 NyLPC_TUInt16 NyLPC_TIPv4Header_makeIpChecksum(const struct NyLPC_TIPv4Header* ip_header);
nyatla 109:18f12ac01097 253
nyatla 109:18f12ac01097 254
nyatla 109:18f12ac01097 255 NyLPC_TUInt16 NyLPC_TIPv4Header_makeTcpChecksum(
nyatla 109:18f12ac01097 256 const struct NyLPC_TIPv4Header* i_iph);
nyatla 109:18f12ac01097 257
nyatla 109:18f12ac01097 258 #define NyLPC_TIPv4Header_isDestAddrEqual(i_struct,i_addr) ((i_struct)->destipaddr==(i_addr))
nyatla 109:18f12ac01097 259 #define NyLPC_TIPv4Header_isSrcAddrEqual(i_struct,i_addr) ((i_struct)->srcipaddr==(i_addr))
nyatla 109:18f12ac01097 260
nyatla 109:18f12ac01097 261 /**
nyatla 109:18f12ac01097 262 * IPヘッダの長さを返す。
nyatla 109:18f12ac01097 263 */
nyatla 109:18f12ac01097 264 #define NyLPC_TIPv4Header_getHeaderLength(i_iph) (((i_iph)->vhl & 0x0f)*4)
nyatla 109:18f12ac01097 265 /**
nyatla 109:18f12ac01097 266 * IPパケット全体の長さを返す。
nyatla 109:18f12ac01097 267 */
nyatla 109:18f12ac01097 268 #define NyLPC_TIPv4Header_getPacketLength(i_iph) (NyLPC_ntohs((i_iph)->len16))
nyatla 109:18f12ac01097 269
nyatla 109:18f12ac01097 270 /**
nyatla 109:18f12ac01097 271 * IPヘッダを送信パケット用に設定する。
nyatla 109:18f12ac01097 272 * ipid16にはコールされるたびに新しい値を設定する。
nyatla 109:18f12ac01097 273 * ipcecksumには0を設定する。
nyatla 109:18f12ac01097 274 * この関数は、パケットサイズ,ローカルIP/リモートIPの設定はしない。
nyatla 109:18f12ac01097 275 */
nyatla 109:18f12ac01097 276 void NyLPC_TIPv4Header_writeTxIpHeader(
nyatla 109:18f12ac01097 277 struct NyLPC_TIPv4Header* i_struct,
nyatla 109:18f12ac01097 278 NyLPC_TUInt8 i_proto);
nyatla 109:18f12ac01097 279 /**********************************************************************
nyatla 109:18f12ac01097 280 *
nyatla 109:18f12ac01097 281 * struct NyLPC_TIPv6Header
nyatla 109:18f12ac01097 282 *
nyatla 109:18f12ac01097 283 **********************************************************************/
nyatla 109:18f12ac01097 284
nyatla 109:18f12ac01097 285
nyatla 109:18f12ac01097 286 struct NyLPC_TIPv6Header
nyatla 109:18f12ac01097 287 {
nyatla 109:18f12ac01097 288 /* IPv6 header. */
nyatla 109:18f12ac01097 289 NyLPC_TUInt8 vtc;
nyatla 109:18f12ac01097 290 NyLPC_TUInt8 tcflow;
nyatla 109:18f12ac01097 291 NyLPC_TUInt16 flow;
nyatla 109:18f12ac01097 292 NyLPC_TUInt8 len16;
nyatla 109:18f12ac01097 293 NyLPC_TUInt8 proto, ttl;
nyatla 109:18f12ac01097 294 uip_ip6addr_t srcipaddr;
nyatla 109:18f12ac01097 295 uip_ip6addr_t destipaddr;
nyatla 109:18f12ac01097 296 }PACK_STRUCT_END;
nyatla 109:18f12ac01097 297
nyatla 109:18f12ac01097 298 void NyLPC_TIPv6Header_setSendHeader(
nyatla 109:18f12ac01097 299 struct NyLPC_TIPv6Header* i_iph,
nyatla 109:18f12ac01097 300 uip_ip6addr_t i_src,
nyatla 109:18f12ac01097 301 uip_ip6addr_t i_dest,
nyatla 109:18f12ac01097 302 NyLPC_TUInt8 i_proto,
nyatla 109:18f12ac01097 303 NyLPC_TUInt8 i_ttl,
nyatla 109:18f12ac01097 304 NyLPC_TUInt16 i_len);
nyatla 109:18f12ac01097 305
nyatla 109:18f12ac01097 306 NyLPC_TUInt16 NyLPC_TIPv6Header_makeTcpChecksum(
nyatla 109:18f12ac01097 307 struct NyLPC_TIPv6Header* i_iph,
nyatla 109:18f12ac01097 308 NyLPC_TUInt16 i_len);
nyatla 109:18f12ac01097 309
nyatla 109:18f12ac01097 310 #define NyLPC_TIPv6Header_isDestAddrEqual(i_struct,i_addr) (memcmp((i_struct)->destipaddr,(i_addr),sizeof(uip_ip6addr_t)))
nyatla 109:18f12ac01097 311 #define NyLPC_TIPv6Header_isSrcAddrEqual(i_struct,i_addr) (memcmp(i_struct)->srcipaddr,(i_addr),sizeof(uip_ip6addr_t)))
nyatla 109:18f12ac01097 312 /**********************************************************************
nyatla 109:18f12ac01097 313 *
nyatla 109:18f12ac01097 314 * struct NyLPC_TTcpHeader
nyatla 109:18f12ac01097 315 *
nyatla 109:18f12ac01097 316 **********************************************************************/
nyatla 109:18f12ac01097 317 #define TCP_OPT_END 0 /* End of TCP options list */
nyatla 109:18f12ac01097 318 #define TCP_OPT_NOOP 1 /* "No-operation" TCP option */
nyatla 109:18f12ac01097 319 #define TCP_OPT_MSS 2 /* Maximum segment size TCP option */
nyatla 109:18f12ac01097 320 #define TCP_OPT_MSS_LEN 4 /* Length of TCP MSS option. */
nyatla 109:18f12ac01097 321
nyatla 109:18f12ac01097 322 /**
nyatla 109:18f12ac01097 323 * TCP/IPヘッダのメモリマップ構造体
nyatla 109:18f12ac01097 324 * マルチバイトの値は、全てネットワークオーダーです。
nyatla 109:18f12ac01097 325 */
nyatla 109:18f12ac01097 326 struct NyLPC_TTcpHeader
nyatla 109:18f12ac01097 327 {
nyatla 109:18f12ac01097 328 //TCP header.
nyatla 109:18f12ac01097 329 NyLPC_TUInt16 srcport;
nyatla 109:18f12ac01097 330 NyLPC_TUInt16 destport;
nyatla 109:18f12ac01097 331 NyLPC_TUInt32 seqno32;
nyatla 109:18f12ac01097 332 NyLPC_TUInt32 ackno32;
nyatla 109:18f12ac01097 333 NyLPC_TUInt8 tcpoffset;
nyatla 109:18f12ac01097 334 NyLPC_TUInt8 flags;
nyatla 109:18f12ac01097 335 NyLPC_TUInt16 wnd16;
nyatla 109:18f12ac01097 336 NyLPC_TUInt16 tcpchksum;
nyatla 109:18f12ac01097 337 NyLPC_TUInt8 urgp[2];
nyatla 109:18f12ac01097 338 // NyLPC_TUInt8 optdata[4];
nyatla 109:18f12ac01097 339 } PACK_STRUCT_END;
nyatla 109:18f12ac01097 340
nyatla 109:18f12ac01097 341
nyatla 109:18f12ac01097 342 NyLPC_TUInt8* NyLPC_TTcpHeader_getTcpOptFragmentPtr(
nyatla 109:18f12ac01097 343 const struct NyLPC_TTcpHeader* i_struct,
nyatla 109:18f12ac01097 344 NyLPC_TUInt8 i_opt_id);
nyatla 109:18f12ac01097 345
nyatla 109:18f12ac01097 346 NyLPC_TBool NyLPC_TTcpHeader_getTcpMmsOpt(
nyatla 109:18f12ac01097 347 const struct NyLPC_TTcpHeader* i_struct,NyLPC_TUInt16* o_val);
nyatla 109:18f12ac01097 348
nyatla 109:18f12ac01097 349 /**
nyatla 109:18f12ac01097 350 * この関数は、TCPヘッダの長さを返します。ヘッダの長さは、i_structのフィールドから計算します。
nyatla 109:18f12ac01097 351 * @param i_struct
nyatla 109:18f12ac01097 352 * 構造体のアドレス。
nyatla 109:18f12ac01097 353 */
nyatla 109:18f12ac01097 354 NyLPC_TUInt16 NyLPC_TTcpHeader_getHeaderLength(const struct NyLPC_TTcpHeader* i_struct);
nyatla 109:18f12ac01097 355
nyatla 109:18f12ac01097 356 /**
nyatla 109:18f12ac01097 357 * この関数は、指定したアドレスに、mmsオプション値を書き込みます。
nyatla 109:18f12ac01097 358 */
nyatla 109:18f12ac01097 359 void NyLPC_TTcpHeader_setMmsOpt(NyLPC_TUInt8* i_opt_addr,NyLPC_TUInt16 i_mms);
nyatla 109:18f12ac01097 360
nyatla 109:18f12ac01097 361
nyatla 109:18f12ac01097 362 /**********************************************************************
nyatla 109:18f12ac01097 363 *
nyatla 109:18f12ac01097 364 * struct NyLPC_TUdpHeader
nyatla 109:18f12ac01097 365 *
nyatla 109:18f12ac01097 366 **********************************************************************/
nyatla 109:18f12ac01097 367
nyatla 109:18f12ac01097 368 /**
nyatla 109:18f12ac01097 369 * UDP/IPヘッダのメモリマップ構造体
nyatla 109:18f12ac01097 370 */
nyatla 109:18f12ac01097 371 struct NyLPC_TUdpHeader
nyatla 109:18f12ac01097 372 {
nyatla 109:18f12ac01097 373 NyLPC_TUInt16 srcport;
nyatla 109:18f12ac01097 374 NyLPC_TUInt16 destport;
nyatla 109:18f12ac01097 375 NyLPC_TUInt16 udplen;
nyatla 109:18f12ac01097 376 NyLPC_TUInt16 udpchksum;
nyatla 109:18f12ac01097 377 } PACK_STRUCT_END;
nyatla 109:18f12ac01097 378
nyatla 109:18f12ac01097 379 /**
nyatla 109:18f12ac01097 380 * UDPヘッダの長さを返す。
nyatla 109:18f12ac01097 381 */
nyatla 109:18f12ac01097 382 #define NyLPC_TUdpHeader_getHeaderLength(i_struct) (8)
nyatla 109:18f12ac01097 383
nyatla 109:18f12ac01097 384 /**********************************************************************
nyatla 109:18f12ac01097 385 *
nyatla 109:18f12ac01097 386 * struct NyLPC_TIcmpipHeader
nyatla 109:18f12ac01097 387 *
nyatla 109:18f12ac01097 388 **********************************************************************/
nyatla 109:18f12ac01097 389
nyatla 109:18f12ac01097 390
nyatla 109:18f12ac01097 391 struct NyLPC_TIcmpHeader
nyatla 109:18f12ac01097 392 {
nyatla 109:18f12ac01097 393 /* ICMP (echo) header. */
nyatla 109:18f12ac01097 394 NyLPC_TUInt8 type, icode;
nyatla 109:18f12ac01097 395 NyLPC_TUInt16 icmpchksum;
nyatla 109:18f12ac01097 396 #if !UIP_CONF_IPV6
nyatla 109:18f12ac01097 397 NyLPC_TUInt16 id, seqno;
nyatla 109:18f12ac01097 398 #else /* !UIP_CONF_IPV6 */
nyatla 109:18f12ac01097 399 NyLPC_TUInt8 flags, reserved1, reserved2, reserved3;
nyatla 109:18f12ac01097 400 NyLPC_TUInt8 icmp6data[16];
nyatla 109:18f12ac01097 401 NyLPC_TUInt8 options[1];
nyatla 109:18f12ac01097 402 #endif /* !UIP_CONF_IPV6 */
nyatla 109:18f12ac01097 403 } PACK_STRUCT_END;
nyatla 109:18f12ac01097 404
nyatla 109:18f12ac01097 405 /**********************************************************************
nyatla 109:18f12ac01097 406 *
nyatla 109:18f12ac01097 407 * struct NyLPC_TIcmpipHeader
nyatla 109:18f12ac01097 408 *
nyatla 109:18f12ac01097 409 **********************************************************************/
nyatla 109:18f12ac01097 410
nyatla 109:18f12ac01097 411 struct NyLPC_TArpHeader
nyatla 109:18f12ac01097 412 {
nyatla 109:18f12ac01097 413 NyLPC_TUInt16 hwtype;
nyatla 109:18f12ac01097 414 NyLPC_TUInt16 protocol;
nyatla 109:18f12ac01097 415 NyLPC_TUInt8 hwlen;
nyatla 109:18f12ac01097 416 NyLPC_TUInt8 protolen;
nyatla 109:18f12ac01097 417 NyLPC_TUInt16 opcode;
nyatla 109:18f12ac01097 418 struct NyLPC_TEthAddr shwaddr;
nyatla 109:18f12ac01097 419 struct NyLPC_TIPv4Addr sipaddr;
nyatla 109:18f12ac01097 420 struct NyLPC_TEthAddr dhwaddr;
nyatla 109:18f12ac01097 421 struct NyLPC_TIPv4Addr dipaddr;
nyatla 109:18f12ac01097 422 } PACK_STRUCT_END;
nyatla 109:18f12ac01097 423
nyatla 109:18f12ac01097 424
nyatla 109:18f12ac01097 425 /**
nyatla 109:18f12ac01097 426 * i_req_addrを問い合わせるARP_REQUESTを生成します。
nyatla 109:18f12ac01097 427 */
nyatla 109:18f12ac01097 428 void NyLPC_TArpHeader_setArpRequest(
nyatla 109:18f12ac01097 429 struct NyLPC_TArpHeader* i_struct,
nyatla 109:18f12ac01097 430 const struct NyLPC_TIPv4Addr i_saddr,
nyatla 109:18f12ac01097 431 const struct NyLPC_TEthAddr* i_srceth,
nyatla 109:18f12ac01097 432 const struct NyLPC_TIPv4Addr* i_req_addr);
nyatla 109:18f12ac01097 433
nyatla 109:18f12ac01097 434
nyatla 109:18f12ac01097 435 typedef struct NyLPC_TcEthernetIIPayload NyLPC_TcEthernetIIPayload_t;
nyatla 109:18f12ac01097 436
nyatla 109:18f12ac01097 437
nyatla 109:18f12ac01097 438
nyatla 109:18f12ac01097 439
nyatla 109:18f12ac01097 440 /**********************************************************************
nyatla 109:18f12ac01097 441 *
nyatla 109:18f12ac01097 442 * NyLPC_TIPv6Payload
nyatla 109:18f12ac01097 443 *
nyatla 109:18f12ac01097 444 **********************************************************************/
nyatla 109:18f12ac01097 445
nyatla 109:18f12ac01097 446
nyatla 109:18f12ac01097 447 struct NyLPC_TIPv6Payload
nyatla 109:18f12ac01097 448 {
nyatla 109:18f12ac01097 449 struct NyLPC_TIPv6Header* header;
nyatla 109:18f12ac01097 450 union{
nyatla 109:18f12ac01097 451 void* rawbuf;
nyatla 109:18f12ac01097 452 void* tcp;
nyatla 109:18f12ac01097 453 void* udp;
nyatla 109:18f12ac01097 454 void* icmp6;
nyatla 109:18f12ac01097 455 }payload;
nyatla 109:18f12ac01097 456 };
nyatla 109:18f12ac01097 457
nyatla 109:18f12ac01097 458 struct NyLPC_TcEthernetIIPayload
nyatla 109:18f12ac01097 459 {
nyatla 109:18f12ac01097 460 struct NyLPC_TEthernetIIHeader* header;
nyatla 109:18f12ac01097 461 union{
nyatla 109:18f12ac01097 462 void* rawbuf;
nyatla 109:18f12ac01097 463 struct NyLPC_TArpHeader* arp;
nyatla 109:18f12ac01097 464 struct NyLPC_TIPv4Payload* ipv4;
nyatla 109:18f12ac01097 465 struct NyLPC_TIPv6Payload* ipv6;
nyatla 109:18f12ac01097 466 }payload;
nyatla 109:18f12ac01097 467 NyLPC_TUInt16 len;
nyatla 109:18f12ac01097 468 };
nyatla 109:18f12ac01097 469
nyatla 109:18f12ac01097 470
nyatla 109:18f12ac01097 471
nyatla 109:18f12ac01097 472
nyatla 109:18f12ac01097 473
nyatla 109:18f12ac01097 474 #ifdef __cplusplus
nyatla 109:18f12ac01097 475 }
nyatla 109:18f12ac01097 476 #endif /* __cplusplus */
nyatla 109:18f12ac01097 477
nyatla 109:18f12ac01097 478
nyatla 109:18f12ac01097 479 #endif
nyatla 109:18f12ac01097 480