Editing UIP

This wiki describes how to use uIP (a Light-weight TCP/IP stack) for developing ethernet applications for 8/16-bit embedded system (see [{{SERVER}}/Ethernet_Module Ethernet_Module]).

==Introduction==
*Developed by Adam Dunkels of the Networked Embedded Systems group at the Swedish Institute of Computer Science.
*[http://www.sics.se/~adam/uip/ uIP] is under the [http://www.sics.se/~adam/uip/index.php/License BSD-style license]


==Bug List==
*DHCP
**dhcp client fault from buffalo router
**occasionally cannot access webserver with dhcp
*DHCP
**dhcp client fault from main router
**occasionally cannot access webserver with dhcp
**possible cause: module tries to get IP configuration when switching on and off too frequently. This causes the router to enter into an unknown state. Even using the static mode with the same IP cannot get Internet access properly. When wait for some time and switch on the module again, the router may have been "reset", and the connection is ok again.
*SMTP
**some router cannot used SMTP module
**the router return its own IP as DNS resolver, and it does support only parsing direct IP function
**desktop applications (e.g. outlook, thunderbird, webmail) do not use DNS resolver (UDP application) to connect to the mail server, but use TCP/IP to do the job


==To-Do List==
*32kB constant limitations
**see if webserver can be stored in flash in file system
*[{{SERVER}}/Ethernet_Module#SNMP_Agent SNMP]
**porting snmp to uip
**reference to lwip
**a API(or any method) to let other system to talk to our device OR by scpi, modbus
*https by SSL
**on chip SSL(more faster) OR software SSL(need to upgrade CPU power to process the calculation)
**reference - http://www.networkworld.com/news/tech/2002/0729tech.html


==Porting==
===CVS Repository===
{|border="1" cellspacing="0" cellpadding="5"
! Attribute !! Value
|-valign="top"
| Host || uip-stack.cvs.sourceforge.net
|-
| Repository Path || /cvsroot/uip-stack
|-
| Connection Type || pserver
|-
| User || anonymous
|-
|}


===Patches===
*Changes made to CVS Repository for porting to [http://chungyan5.no-ip.org/vc/?root=freertos_posix freertos_posix]
*uip-patch-1.0-01.diff (minimal)
**'''uip.c'''
***Comment out all DEBUG_PRINTF(...) in lines 1, 323, 910, 1015, 1070, 1863, 1868, 1869
*uip-patch-1.0-02.diff (for pic30-elf-gcc compiler v3.01 or above)
**'''uip.h'''
***Change line 1070 to<br>#      define HTONS(n) (u16_t)(((((u16_t) (n)) << 8)&0xff00) | ((((u16_t) (n)) >> 8)&0x00ff))
**'''psock.c'''
***Change line 188 to<br>s->sendptr = (u8_t*) buf;
***Change lines 276, 303 to<br>buf_setup(&psock->buf, (u8_t*)(psock->bufptr), psock->bufsize);
***Change line 334 to<br>buf_setup(&psock->buf, (u8_t*)buffer, buffersize);


===Implementation===
*Include the following files to use the uIP stack
**timer.c
**uip.c
**uip_arp.c
**psock.c
*The following files have been created to port uIP 1.0 to dsPic33F development board using FreeRTOS
*[http://chungyan5.no-ip.org/vc/trunk/demo_posix/dspic/drivers/?root=freertos_posix clock-arch.c]: return the os tick counts since the system is turned on.
*[http://chungyan5.no-ip.org/vc/trunk/demo_posix/dspic/drivers/include/?root=freertos_posix clock-arch.h]: a constant specifying the number of os ticks in one second.
*uip-config.h: configuration for your application.


==uIP Ethernet Application==
*The following applications are modified from the demo applications in uIP.

===DHCP Client===
*Use project [http://chungyan5.no-ip.org/vc/?root=dhcpc_8bit dhcpc_8bit]
*Enable UDP in "uip-config.h"
      #define UIP_CONF_UDP             1
*Make sure your uip buffer size is large enough (DHCP messages from some servers can be more than 500 bytes). In my setting, I use 1536 in "uip-config.h"
      #define UIP_CONF_BUFFER_SIZE     1536


===Web Server===
*Use project [http://chungyan5.no-ip.org/vc/?root=webserver_8bit webserver_8bit]
====add-on====
*The Web Server included in uIP 1.0 has been designed to load/reload the entire page (either html/shtml files) in response to a HTTP GET command, e.g.
   GET /index.html HTTP/1.1
   GET /abc.shtml HTTP/1.1
*As a result, if the webpage is required to refresh the dynamic data periodically, the surfing experience will be degraded by the large transfer of datastream.
*In consideration of the above issue, a solution is proposed here, so that the webserver can handle this kind of cgi HTTP-request
   GET /abc.shtml?val=500.0&button=Set HTTP/1.1


===DNS Resolver===
*Use project [http://chungyan5.no-ip.org/vc/?root=dns_resolv_8bit dns_resolv_8bit]
*The uIP DNS resolver functions are used to lookup a hostname and map it to a numerical IP address. It maintains a list of resolved hostnames that can be queried with the resolv_lookup() function. New hostnames can be resolved using the resolv_query() function.
*When a hostname has been resolved (or found to be non-existant), the resolver code calls a callback function called resolv_found() that must be implemented by the module that uses the resolver.
*Router Setting
**Special attention should be paid to router setting, when the DNS Server address is acquired by DHCP.
**The DNS Resolver module assumes that the DNS server can support DNS TYPE of ANY, MX, CNAME and A. See http://www.networksorcery.com/enp/protocol/dns.htm for definitions of these options.
*In case the router itself does not support these options, the router should be set to deliver a DNS Server address which support these options.


===SMTP Mail Client===
*Use project [http://chungyan5.no-ip.org/vc/?root=smtpc_8bit smtpc_8bit]
*The SMTP client searches the ip address of the mail server by a DNS call. It then logins to the server with the email account name and address using AUTH LOGIN. If login is successful, the mail is sent to the list of recipients.


===SNMP Agent (Not implemented yet)===
*Simple Network Management Protocol (SNMP) is a standard protocol to access variables to remote device via the Internet. Reference in [http://en.wikipedia.org/wiki/Simple_Network_Management_Protocol wikipedia.org]
*It belongs to the Application Layer, as in HTTP.
*If a device is SNMP compatible, any SNMP compatible host system can monitor and control that device.

====Components in a SNMP System====
*Network Management Station (NMS)
**This is a client, initiating SNMP communication.
**This can be a PC with an NMS software (e.g. [http://nino.sourceforge.net/nino/index.html NINO]), polling data from the SNMP agents periodically.
*SNMP Agents
**These are servers, responding to one or multiple NMS requests.
*Management Information Base (MIB)
**A special collection of variables managed by the SNMP agents.
**MIB has a tree-like structure.
**An Object Identifier (OID) is given for each node.
**Data are stored at the end-nodes.
**Private variables may be constructed under the "enterprise" sub-tree.
**The OID for "enterprise" can be obtained from [http://www.iana.org/cgi-bin/enterprise.pl Internet Assigned Number Authority (IANA)].

====Abstract Syntax Notation====
*Each MIB variable contains several attributes, such as data type, access type and object identifier.
*Abstract Syntax Notation version 1 (ASN.1) is a language to define these attributes in SNMP.

====To-Do List====
*Build MIB file.
**Build MIB file's written in [http://www.itu.int/ITU-T/studygroups/com17/languages/X.680-0207.pdf ANS.1 notation].
**Build MIB compiler tool to compile MIB file to binary file (store tree structure: oid, id, data type, value, position) and C header file (store id to determine a function service the oid).
**Build MIB converter tool to convert binary MIB file to C header file (embedded to code). Note: binary MIB file can store in MMC/SD card (don't need MIB converter tool).

                                 [https://www.ee.buu.ac.th/~acitl/EthernetMini/MCHPTCPStack%203.75/mib2bib.exe MIB compiler tools]
  [http://www.modtronix.com/products/sbc44ec/00870a.pdf foo.mib] (ANS.1 format)   -----------------------------------> foo.bin + oid.h (store ID that's reference to function service of OID)
  
                                 MIB converter tools
  foo.bin                  -----------------------------------> foo.h (store the structure of OID tree)

*Build [http://www.rane.com/note161.html snmp's PDU use BER (Base encoding rules)] encoder and decoder library to process data that's transfer between NMS and agents.
*Build snmp API use [http://www.sics.se/~adam/uip/index.php/Main_Page uIP-stack] to communicate between NMS and Agents (open two ports: The manager speak to agents on one port, the agent responds manager on the other port).
*Build binary MIB file reader library.
*Build functions service oid tree.
*Merge MIB ANS.1 file to NMS.

==Reference==
===uIP===
*[http://www.sics.se/~adam/uip/index.php/Main_Page uIP Description]
*[http://www.sics.se/~adam/uip/index.php/Documentation uIP Documentation]
*[http://www.sics.se/~adam/uip/index.php/Download Download]
*[http://sourceforge.net/cvs/?group_id=186227 CVS Repository]
===lwIP===
*[http://savannah.nongnu.org/projects/lwip/ lwIP Description]
*[http://www.nongnu.org/lwip/ Documentation]
===HTML===
*[http://www.w3schools.com/default.asp W3 Schools]: Learning how to write HTML and JavaScript
===SNMP===
*[http://www.snmplink.org SNMP Link]: Information on SNMP Agents
*[http://pen.iana.org/pen/PenApplication.page IANA]: Applying a Private Enterprise Number
*[http://www.itu.int/ITU-T/studygroups/com17/languages/X.680-0207.pdf ASN.1]: Abstract Syntax Notation One (ASN.1):Specification of basic notation