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.

Import programMbedFileServer

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

サンプル

Import programMiMicSimpleHttpd

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

Import programUPnPBasicDevice

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

Import programWebSocketSample

MiMicSDK Websocket module sample program.

Import programHttpClientSamlpe

A http client sample program.

Import programTcpSocketClientSamlpe

MiMicSDK Tcp client socket sample program.

Import programUdpSocketSamlpe

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

チュートリアル

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.

Import programMbedFileServer

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

Sample

Import programMiMicSimpleHttpd

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

Import programUPnPBasicDevice

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

Import programWebSocketSample

MiMicSDK Websocket module sample program.

Import programHttpClientSamlpe

A http client sample program.

Import programTcpSocketClientSamlpe

MiMicSDK Tcp client socket sample program.

Import programUdpSocketSamlpe

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

Tutorial

Committer:
nyatla
Date:
Thu May 29 14:29:15 2014 +0000
Revision:
69:8c5f220441f5
Parent:
63:157ee3202edb
r354????; LPC4088?????

Who changed what in which revision?

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