summaryrefslogtreecommitdiffstats
path: root/src/proto
diff options
context:
space:
mode:
authorMichael Brown2006-03-23 22:32:03 +0100
committerMichael Brown2006-03-23 22:32:03 +0100
commita4a0244aa31b6759306be821db8420c858ea7617 (patch)
tree881c2686a75a5d813a85ef345fd40e73482e7242 /src/proto
parentAdd include/gpxe as a directory to scan. (diff)
downloadipxe-a4a0244aa31b6759306be821db8420c858ea7617.tar.gz
ipxe-a4a0244aa31b6759306be821db8420c858ea7617.tar.xz
ipxe-a4a0244aa31b6759306be821db8420c858ea7617.zip
Moved uIP wrapper out of prototester.c and into proto/tcp.c.
Diffstat (limited to 'src/proto')
-rw-r--r--src/proto/tcp.c206
1 files changed, 206 insertions, 0 deletions
diff --git a/src/proto/tcp.c b/src/proto/tcp.c
new file mode 100644
index 00000000..8c732015
--- /dev/null
+++ b/src/proto/tcp.c
@@ -0,0 +1,206 @@
+#include <string.h>
+#include <assert.h>
+#include <byteswap.h>
+#include <gpxe/tcp.h>
+#include "uip/uip.h"
+#include "uip/uip_arp.h"
+
+/** @file
+ *
+ * TCP protocol
+ *
+ * The gPXE TCP stack is currently implemented on top of the uIP
+ * protocol stack. This file provides wrappers around uIP so that
+ * higher-level protocol implementations do not need to talk directly
+ * to uIP (which has a somewhat baroque API).
+ *
+ * Basic operation is to create a #tcp_connection structure, call
+ * tcp_connect() and then call run_tcpip() in a loop until the
+ * operation has completed. The TCP stack will call the various
+ * methods defined in the #tcp_operations structure in order to send
+ * and receive data.
+ *
+ * See hello.c for a trivial example of a TCP protocol using this
+ * API.
+ *
+ */
+
+/**
+ * Initialise TCP/IP stack
+ *
+ */
+void init_tcpip ( void ) {
+ uip_init();
+ uip_arp_init();
+}
+
+#define UIP_HLEN ( 40 + UIP_LLH_LEN )
+
+/**
+ * Transmit TCP data
+ *
+ * This is a wrapper around netdev_transmit(). It gathers up the
+ * packet produced by uIP, and then passes it to netdev_transmit() as
+ * a single buffer.
+ */
+static void uip_transmit ( void ) {
+ uip_arp_out();
+ if ( uip_len > UIP_HLEN ) {
+ memcpy ( uip_buf + UIP_HLEN, ( void * ) uip_appdata,
+ uip_len - UIP_HLEN );
+ }
+ netdev_transmit ( uip_buf, uip_len );
+ uip_len = 0;
+}
+
+/**
+ * Run the TCP/IP stack
+ *
+ * Call this function in a loop in order to allow TCP/IP processing to
+ * take place. This call takes the stack through a single iteration;
+ * it will typically be used in a loop such as
+ *
+ * @code
+ *
+ * struct tcp_connection *my_connection;
+ * ...
+ * tcp_connect ( my_connection );
+ * while ( ! my_connection->finished ) {
+ * run_tcpip();
+ * }
+ *
+ * @endcode
+ *
+ * where @c my_connection->finished is set by one of the connection's
+ * #tcp_operations methods to indicate completion.
+ */
+void run_tcpip ( void ) {
+ void *data;
+ size_t len;
+ uint16_t type;
+ int i;
+
+ if ( netdev_poll ( 1, &data, &len ) ) {
+ /* We have data */
+ memcpy ( uip_buf, data, len );
+ uip_len = len;
+ type = ntohs ( *( ( uint16_t * ) ( uip_buf + 12 ) ) );
+ if ( type == UIP_ETHTYPE_ARP ) {
+ uip_arp_arpin();
+ } else {
+ uip_arp_ipin();
+ uip_input();
+ }
+ if ( uip_len > 0 )
+ uip_transmit();
+ } else {
+ for ( i = 0 ; i < UIP_CONNS ; i++ ) {
+ uip_periodic ( i );
+ if ( uip_len > 0 )
+ uip_transmit();
+ }
+ }
+}
+
+/**
+ * Open a TCP connection
+ *
+ * @v conn TCP connection
+ * @ret 0 Success
+ * @ret <0 Failure
+ *
+ * This sets up a new TCP connection to the remote host specified in
+ * tcp_connection::sin. The actual SYN packet will not be sent out
+ * until run_tcpip() is called for the first time.
+ *
+ * @todo Use linked lists instead of a static buffer, and thereby
+ * remove the only potential failure case, giving this function
+ * a void return type.
+ */
+int tcp_connect ( struct tcp_connection *conn ) {
+ struct uip_conn *uip_conn;
+ u16_t ipaddr[2];
+
+ assert ( conn->sin.sin_addr.s_addr != 0 );
+ assert ( conn->sin.sin_port != 0 );
+ assert ( conn->tcp_op != NULL );
+ assert ( sizeof ( uip_conn->appstate ) == sizeof ( conn ) );
+
+ * ( ( uint32_t * ) ipaddr ) = conn->sin.sin_addr.s_addr;
+ uip_conn = uip_connect ( ipaddr, conn->sin.sin_port );
+ if ( ! uip_conn )
+ return -1;
+
+ *( ( void ** ) uip_conn->appstate ) = conn;
+ return 0;
+}
+
+/**
+ * Send data via a TCP connection
+ *
+ * @v conn TCP connection
+ * @v data Data to send
+ * @v len Length of data
+ *
+ * Data will be automatically limited to the current TCP window size.
+ *
+ * If retransmission is required, the connection's
+ * tcp_operations::newdata() method will be called again in order to
+ * regenerate the data.
+ */
+void tcp_send ( struct tcp_connection *conn __unused,
+ const void *data, size_t len ) {
+ assert ( conn = *( ( void ** ) uip_conn->appstate ) );
+ uip_send ( ( void * ) data, len );
+}
+
+/**
+ * Close a TCP connection
+ *
+ * @v conn TCP connection
+ */
+void tcp_close ( struct tcp_connection *conn __unused ) {
+ assert ( conn = *( ( void ** ) uip_conn->appstate ) );
+ uip_close();
+}
+
+/**
+ * uIP TCP application call interface
+ *
+ * This is the entry point of gPXE from the point of view of the uIP
+ * protocol stack. This function calls the appropriate methods from
+ * the connection's @tcp_operations table in order to process received
+ * data, transmit new data etc.
+ */
+void uip_tcp_appcall ( void ) {
+ struct tcp_connection *conn = *( ( void ** ) uip_conn->appstate );
+ struct tcp_operations *op = conn->tcp_op;
+
+ assert ( conn->tcp_op->closed != NULL );
+ assert ( conn->tcp_op->connected != NULL );
+ assert ( conn->tcp_op->acked != NULL );
+ assert ( conn->tcp_op->newdata != NULL );
+ assert ( conn->tcp_op->senddata != NULL );
+
+ if ( uip_aborted() && op->aborted ) /* optional method */
+ op->aborted ( conn );
+ if ( uip_timedout() && op->timedout ) /* optional method */
+ op->timedout ( conn );
+ if ( uip_closed() && op->closed ) /* optional method */
+ op->closed ( conn );
+ if ( uip_connected() )
+ op->connected ( conn );
+ if ( uip_acked() )
+ op->acked ( conn, uip_conn->len );
+ if ( uip_newdata() )
+ op->newdata ( conn, ( void * ) uip_appdata, uip_len );
+ if ( uip_rexmit() || uip_newdata() || uip_acked() ||
+ uip_connected() || uip_poll() )
+ op->senddata ( conn );
+}
+
+/* Present here to allow everything to link. Will go into separate
+ * udp.c file
+ */
+void uip_udp_appcall ( void ) {
+}