Initial commit

Author: oilulio

Makefile

@@ -0,0 +1,48 @@
+PRJ = Net
+MCU = atmega328p
+#CLK = 16000000  
+# CLK usually defined in config.h
+AVRPATH=c:\WinAVR-20100110\bin
+COMPORT=COM4
+
+CC = ${AVRPATH}\avr-gcc
+AVRDUDE = avrdude
+OBJCOPY = ${AVRPATH}\avr-objcopy
+OBJDUMP = $(AVRPATH)\avr-objdump
+SIZE    = $(AVRPATH)\avr-size --format=avr --mcu=$(MCU)
+CFLAGS    = -Wall -Os -mmcu=$(MCU) -c -std=gnu99 -funsigned-char -funsigned-bitfields -ffunction-sections -fdata-sections -fpack-struct -fshort-enums -gdwarf-2
+#-DF_CPU=$(CLK)
+SRCS = application.c lfsr.c init.c isp.c mem23SRAM.c w25q.c main.c network.c linkENC28J60.c transport.c md5.c ripemd160.c sha1.c sha256.c power.c
+#where.c
+
+OBJS = $(patsubst %.c,obj/%.o,$(SRCS)) 
+# object files in subdirectory obj, which will (below) be created if needed
+DEPS := $(OBJS:.o=.d)
+# Dependency files for e.g. recompile when header file changes
+
+all: ${PRJ}.hex
+
+${PRJ}.hex: ${PRJ}.elf
+	${OBJCOPY} -O ihex $< $@
+	${SIZE} -C ${PRJ}.elf
+
+${PRJ}.elf: ${OBJS}
+	${CC} -mmcu=${MCU} -Wl,--gc-sections -o $@ $^
+# -Wl,--gc-sections removes unwanted code for space
+
+install: ${PRJ}.hex
+	avrdude -p $(MCU) -c STK500v2 -P $(COMPORT) -V -U flash:w:${PRJ}.hex
+
+$(OBJS): | obj
+  
+obj:
+	@mkdir -p $@  
+  
+-include $(DEPS)  
+  
+obj/%.o: %.c
+	$(CC) $(CFLAGS) -MMD -MF $(patsubst %.o,%.d,$@) -o $@ $<
+# -MMD and -MF make the .d dependency files to ensure we recompile when needed
+  
+clean:
+	rm -f ${PRJ}.elf ${PRJ}.hex ${OBJS} ${DEPS}

README.md

@@ -0,0 +1,13 @@
+# Microcontroller-TCPIP-stack
+A size-optimised stack for (primarily Atmel/Arduino) microcontrollers with UDP and TCP, and zero configuration networking.
+
+Uses DHCP to obtain an IP address, or APIPA or a static IP address.
+
+Is discoverable via zero-configuration protocols (LLMNR, mDNS).  
+
+Supports ARP, limited ICMP (PING) and IP, UDP and TCP.  At the application layer, is a NTP client, a DNS client, and a HTTP client or server. 
+
+Is capable of sending TCP packets larger than the 2k microcontroller memory (e.g. by constructing both the boilerplate and possibly the payload on the fly)
+Is capable of receiving TCP packets also larger than the microcontroller memory by incrementally downloading them from the network card (which has typically 8k)
+
+Functionality can be included/excluded at compile time to trade code size for capability

Receive stack.pdf

@@ -0,0 +1,91 @@
+/* STK500 constants list, from AVRDUDE, from Optiboot
+ *
+ * Trivial set of constants derived from Atmel App Note AVR061
+ * Not copyrighted.  Released to the public domain.
+ 
+ Also from AVR068
+ 
+ */
+
+#define STK_OK              0x10
+#define STK_FAILED          0x11  // Not used
+#define STK_UNKNOWN         0x12  // Not used
+#define STK_NODEVICE        0x13  // Not used
+#define STK_INSYNC          0x14  // ' '
+#define STK_NOSYNC          0x15  // Not used
+#define ADC_CHANNEL_ERROR   0x16  // Not used
+#define ADC_MEASURE_OK      0x17  // Not used
+#define PWM_CHANNEL_ERROR   0x18  // Not used
+#define PWM_ADJUST_OK       0x19  // Not used
+#define CRC_EOP             0x20  // 'SPACE'
+#define STK_GET_SYNC        0x30  // '0'
+#define STK_GET_SIGN_ON     0x31  // '1'
+#define STK_SET_PARAMETER   0x40  // '@'
+#define STK_GET_PARAMETER   0x41  // 'A'
+#define STK_SET_DEVICE      0x42  // 'B'
+#define STK_SET_DEVICE_EXT  0x45  // 'E'
+#define STK_ENTER_PROGMODE  0x50  // 'P'
+#define STK_LEAVE_PROGMODE  0x51  // 'Q'
+#define STK_CHIP_ERASE      0x52  // 'R'
+#define STK_CHECK_AUTOINC   0x53  // 'S'
+#define STK_LOAD_ADDRESS    0x55  // 'U'
+#define STK_UNIVERSAL       0x56  // 'V'
+#define STK_PROG_FLASH      0x60  // '`'
+#define STK_PROG_DATA       0x61  // 'a'
+#define STK_PROG_FUSE       0x62  // 'b'
+#define STK_PROG_LOCK       0x63  // 'c'
+#define STK_PROG_PAGE       0x64  // 'd'
+#define STK_PROG_FUSE_EXT   0x65  // 'e'
+#define STK_READ_FLASH      0x70  // 'p'
+#define STK_READ_DATA       0x71  // 'q'
+#define STK_READ_FUSE       0x72  // 'r'
+#define STK_READ_LOCK       0x73  // 's'
+#define STK_READ_PAGE       0x74  // 't'
+#define STK_READ_SIGN       0x75  // 'u'
+#define STK_READ_OSCCAL     0x76  // 'v'
+#define STK_READ_FUSE_EXT   0x77  // 'w'
+#define STK_READ_OSCCAL_EXT 0x78  // 'x'
+#define STK_SW_MAJOR        0x81  // ' '
+#define STK_SW_MINOR        0x82  // ' '
+
+
+enum SpiProgrammingProtocolCommands {
+    //**********************************************************
+    // Protocol commands
+    //**********************************************************
+    SPI_CMD_LOAD_ADDRESS                    = 0x06, //! Load address
+    SPI_CMD_ENTER_PROGMODE                  = 0x10, //! Enter programming mode
+    SPI_CMD_LEAVE_PROGMODE                  = 0x11, //! Leave programming mode
+    SPI_CMD_CHIP_ERASE                      = 0x12, //! Erase device
+    SPI_CMD_PROGRAM_FLASH                   = 0x13, //! Program flash data
+    SPI_CMD_READ_FLASH                      = 0x14, //! Read flash data
+    SPI_CMD_PROGRAM_EEPROM                  = 0x15, //! Program EEPROM data
+    SPI_CMD_READ_EEPROM                     = 0x16, //! Read EEPROM data
+    SPI_CMD_PROGRAM_FUSE                    = 0x17, //! Program a fuse byte
+    SPI_CMD_READ_FUSE                       = 0x18, //! Read a fuse byte
+    SPI_CMD_PROGRAM_LOCK                    = 0x19, //! Program lock bits
+    SPI_CMD_READ_LOCK                       = 0x1A, //! Read lock bits
+    SPI_CMD_READ_SIGNATURE                  = 0x1B, //! Read a signature byte
+    SPI_CMD_READ_OSCCAL                     = 0x1C, //! Read an OSCCAL byte
+    SPI_CMD_SET_BAUD                        = 0x1D, //! Set baud rate
+    SPI_CMD_GET_BAUD                        = 0x1E  //! Read baud rate
+};
+
+enum SpiProgrammingProtocolResponses {
+    //**********************************************************
+    // Protocol responses
+    //**********************************************************
+    // Success
+    SPI_STATUS_CMD_OK                       = 0x00, //! All OK
+
+    // Warnings
+    SPI_STATUS_CMD_TOUT                     = 0x80, //! Command timeout
+    SPI_STATUS_RDY_BSY_TOUT                 = 0x81, //! Device busy
+
+    // Errors
+    SPI_STATUS_CMD_FAILED                   = 0xC0, //! Command failed
+    SPI_STATUS_CMD_UNKNOWN                  = 0xC9, //! Unknown error
+    SPI_STATUS_PHY_ERROR                    = 0xCB, //! Physical error
+    SPI_STATUS_CLOCK_ERROR                  = 0xCC, //! Speed error
+    SPI_STATUS_BAUD_INVALID                 = 0xCD  //! Baud value error
+};

STK500.h

@@ -0,0 +1,144 @@
+/*********************************************
+
+Header for Transport layer protocols TCP, UDP
+
+ *********************************************/
+
+#ifndef TRANSPORT_H
+#define TRANSPORT_H
+
+#define UDP_PORT  (1)
+#define TCP_PORT  (2)
+
+//#define START_DYNAMIC_PORTS   (0xC000) 
+#define START_DYNAMIC_PORTS   (0xC080) 
+// See http://www.iana.org/assignments/port-numbers
+
+#define TCP_CLOSED      (1)
+#define TCP_LISTEN      (2)
+#define TCP_SYN_RCVD    (3)
+#define TCP_SYN_SENT    (4)
+#define TCP_ESTABLISHED (5)
+#define TCP_CLOSE_WAIT  (6)
+#define TCP_FIN_WAIT1   (7)
+#define TCP_FIN_WAIT2   (8)
+#define TCP_CLOSING     (9)
+#define TCP_TIME_WAIT   (10)
+#define TCP_LAST_ACK    (11)
+
+#define MAX_TCP_ROLES   (2) // Can combine the below to sum to less than total.
+#define TCP_CLIENT      (0) // Used as array coordinates, hence 0,1
+#define TCP_SERVER      (1)
+#define TCP_FTP_CLIENT  (0) // TODO : currently duplicates above - so use one at time
+#define TCP_FTP_PASSIVE (1)
+
+#define TCP_REJECT      (MAX_TCP_ROLES+1)  // Outside normal range
+// Used to reject a wrong connection - so deliberately not one we recognise
+
+#define ACK_BIT     (1)
+#define DATA_BIT    (2)
+#define CONSEC_BIT  (4)
+
+typedef struct { // UDP header : 8 bytes
+  uint16_t sourcePort;
+  uint16_t destinationPort;
+  uint16_t messageLength;
+  uint16_t UDP_checksum;
+} UDP_header;
+
+#define UDP_HEADER_SIZE (8)
+
+#define FL_FIN (0x01) 
+#define FL_SYN (0x02)
+#define FL_RST (0x04)
+#define FL_PSH (0x08)
+#define FL_ACK (0x10)
+#define FL_URG (0x20)
+
+typedef struct { // TCP header : 20 bytes
+  uint16_t      sourcePort;
+  uint16_t      destinationPort;
+  int32_t       sequence;  // Making these signed allows easy sequence comparisons
+  int32_t       ack;       // See Comer, Internetworking with TCP/IP Vol 2 p173
+  unsigned      unused2        : 4;
+  unsigned      headerLength   : 4;  // In 32 bit words
+  uint8_t       flags;
+  uint16_t      windowSize;
+  uint16_t      TCP_checksum;
+  uint16_t      urgent;
+} TCP_header;
+
+#define TCP_HEADER_SIZE (20)
+
+#define MAX_RETX    (10)  // TCP Packets to keep ready to re transmit
+
+typedef struct { // Details of TCP packet needed for possible Re-transmission
+  uint8_t     role;
+  unsigned    active      :2;
+  unsigned    retries     :6;
+  uint8_t     timeout;
+  uint16_t    payloadLength;  
+  uint16_t    headerLength;
+  int32_t     lastByte;
+  uint8_t     * data;   // Either the packet data ... or a callback to make it.
+  uint16_t    (* callback)(uint16_t start,uint16_t length,uint8_t * result);
+  int32_t     sequence;  // Only needed for callback : the sequence no of start of TCP stream
+  uint16_t    start;     // Only needed for callback : the offset for the callback
+} Retransmit;
+
+typedef struct { // TCP Transmission Control Block (TCB)
+  unsigned     status          :4;  // State machine
+  unsigned     age             :4;  // countdown
+  uint16_t     localPort;
+  uint16_t     remotePort;
+  IP4_address  remoteIP;
+  int32_t      lastByteSent;
+// int32_t     lastAckSent;
+  int32_t      lastByteReceived;
+  int32_t      lastAckReceived;
+  uint16_t     windowSize;
+} TCP_TCB;
+ 
+#define TCP_MAX_AGE   (5)  // Unused connection will timeout after this many s.
+#define TCP_TIMEOUT   (1)  // seconds before retransmit, then BEB
+#define TCP_RETRIES   (3)  // Timeout * 2^Retries should be < 64.
+
+typedef struct  {  // Headers only.  Enough to ACK a TCP
+  Ethernet_header Ethernet;
+  IP4_header IP4; 
+  union {
+    TCP_header TCP;      
+    struct {
+      UDP_header UDP;
+      uint8_t dummy[12];
+    };
+  };
+} MergedACK;
+
+#include "application.h"
+
+#define MAX_PACKET_PAYLOAD (MAX_PACKET_SIZE-IP_HEADER_SIZE-TCP_HEADER_SIZE-ETH_HEADER_SIZE)
+
+// Global functions
+void initialiseTCP(void);
+void countdownTCP(void);
+void retxTCP(void);
+void cleanupOldTCP();
+void initiateTCPConnection(MergedPacket * Mash, uint16_t source_port,
+                                uint16_t destination_port, IP4_address ToIP, uint8_t role);
+void TCP_SimpleDataOut(const char * send,const uint8_t role,uint8_t reTx);
+void TCP_SimpleDataOutProgmem(const char * send,const uint8_t role,uint8_t reTx);
+void TCP_DataIn(MergedPacket * Mash, const uint16_t length, const uint8_t role);
+void TCP_ComplexDataOut(MergedPacket * Mash, const uint8_t role, const uint16_t payloadLength,
+      uint16_t (* callback)(uint16_t start,uint16_t length,uint8_t * result),uint16_t offset,
+	    uint8_t reTx);
+
+void handleTCP(MergedPacket * Mash);
+void handleUDP(MergedPacket * Mash, uint8_t flags);
+void launchUDP(MergedPacket * Mash, IP4_address * ToIP,uint16_t sourcePort, uint16_t destinationPort, 
+   uint16_t data_length,void (* callback)(uint16_t start,uint16_t length,uint8_t * result),uint16_t offset);
+uint16_t newPort(uint8_t protocol);
+void MemOverflow(void);
+
+
+#endif