Subversion Repositories HomeAutomation

/*********************************************************************

 *

 *                  TCP Module Defs for Microchip TCP/IP Stack

 *

 *********************************************************************

 * FileName:        TCP.h

 * Dependencies:    StackTsk.h

 * Processor:       PIC18, PIC24F, PIC24H, dsPIC30F, dsPIC33F

 * Complier:        Microchip C18 v3.02 or higher

 *                  Microchip C30 v2.01 or higher

 * Company:         Microchip Technology, Inc.

 *

 * Software License Agreement

 *

 * This software is owned by Microchip Technology Inc. ("Microchip")

 * and is supplied to you for use exclusively as described in the

 * associated software agreement.  This software is protected by

 * software and other intellectual property laws.  Any use in

 * violation of the software license may subject the user to criminal

 * sanctions as well as civil liability.  Copyright 2006 Microchip

 * Technology Inc.  All rights reserved.

 *

 * This software is provided "AS IS."  MICROCHIP DISCLAIMS ALL

 * WARRANTIES, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, NOT LIMITED

 * TO MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND

 * INFRINGEMENT.  Microchip shall in no event be liable for special,

 * incidental, or consequential damages.

 *

 *

 * Author               Date    Comment

 *~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

 * Nilesh Rajbharti     5/8/01  Original        (Rev 1.0)

 * Nilesh Rajbharti     5/22/02 Rev 2.0 (See version.log for detail)

 * Nilesh Rajbharti     12/5/03 Modified TCPProcess() prototype.

 *                              See TCP.c for more information.

 ********************************************************************/

#ifndef TCP_H

#define TCP_H

#include "..\Include\StackTsk.h"

#include "..\Include\Tick.h"

typedef BYTE TCP_SOCKET;

typedef WORD TCP_PORT;

/*

 * Maximum number of times a connection be retried before

 * closing it down.

 */

#define MAX_RETRY_COUNTS    (3)

#define INVALID_SOCKET      (0xfe)

#define UNKNOWN_SOCKET      (0xff)

#define REMOTE_HOST(s)      (TCB[s].remote)

/*

 * TCP States as defined by rfc793

 */

typedef enum _TCP_STATE

{

    TCP_LISTEN = 0,

    TCP_SYN_SENT,

    TCP_SYN_RECEIVED,

    TCP_ESTABLISHED,

    TCP_FIN_WAIT_1,

    TCP_FIN_WAIT_2,

    TCP_CLOSING,

    TCP_TIME_WAIT,

    TCP_CLOSE_WAIT,

    TCP_LAST_ACK,

    TCP_CLOSED,

} TCP_STATE;

/*

 * Socket info.

 * Union is used to create anonymous structure members.

 */

typedef struct _SOCKET_INFO

{

    TCP_STATE smState;

    NODE_INFO remote;

    TCP_PORT localPort;

    TCP_PORT remotePort;

    BUFFER TxBuffer;

    WORD TxCount;

    WORD RxCount;

    WORD RemoteWindow;

    DWORD SND_SEQ;

    DWORD SND_ACK;

    BYTE RetryCount;

    TICK startTick;

    TICK TimeOut;

    struct

    {

        unsigned char bServer        : 1;

        unsigned char bIsPutReady    : 1;

        unsigned char bFirstRead     : 1;

        unsigned char bIsGetReady    : 1;

        unsigned char bIsTxInProgress : 1;

        unsigned char bACKValid : 1;

    } Flags;

} SOCKET_INFO;

#if !defined(THIS_IS_TCP)

/*

 * These are all sockets supported by this TCP.

 */

extern SOCKET_INFO TCB[MAX_SOCKETS];

#endif

/*********************************************************************

 * Function:        void TCPInit(void)

 *

 * PreCondition:    None

 *

 * Input:           None

 *

 * Output:          TCP is initialized.

 *

 * Side Effects:    None

 *

 * Overview:        Initialize all socket info.

 *

 * Note:            This function is called only one during lifetime

 *                  of the application.

 ********************************************************************/

void        TCPInit(void);

/*********************************************************************

 * Function:        TCP_SOCKET TCPListen(TCP_PORT port)

 *

 * PreCondition:    TCPInit() is already called.

 *

 * Input:           port    - A TCP port to be opened.

 *

 * Output:          Given port is opened and returned on success

 *                  INVALID_SOCKET if no more sockets left.

 *

 * Side Effects:    None

 *

 * Overview:        None

 *

 * Note:            None

 ********************************************************************/

TCP_SOCKET  TCPListen(TCP_PORT port);

/*********************************************************************

 * Function:        TCP_SOCKET TCPConnect(NODE_INFO* remote,

 *                                      TCP_PORT remotePort)

 *

 * PreCondition:    TCPInit() is already called.

 *

 * Input:           remote      - Remote node address info

 *                  remotePort  - remote port to be connected.

 *

 * Output:          A new socket is created, connection request is

 *                  sent and socket handle is returned.

 *

 * Side Effects:    None

 *

 * Overview:        None

 *

 * Note:            By default this function is not included in

 *                  source.  You must define STACK_CLIENT_MODE to

 *                  be able to use this function.

 ********************************************************************/

TCP_SOCKET  TCPConnect(NODE_INFO *remote, TCP_PORT port);

/*********************************************************************

 * Function:        BOOL TCPIsConnected(TCP_SOCKET s)

 *

 * PreCondition:    TCPInit() is already called.

 *

 * Input:           s       - Socket to be checked for connection.

 *

 * Output:          TRUE    if given socket is connected

 *                  FALSE   if given socket is not connected.

 *

 * Side Effects:    None

 *

 * Overview:        None

 *

 * Note:            A socket is said to be connected if it is not

 *                  in LISTEN and CLOSED mode.  Socket may be in

 *                  SYN_RCVD or FIN_WAIT_1 and may contain socket

 *                  data.

 ********************************************************************/

BOOL        TCPIsConnected(TCP_SOCKET s);

/*********************************************************************

 * Function:        void TCPDisconnect(TCP_SOCKET s)

 *

 * PreCondition:    TCPInit() is already called     AND

 *                  TCPIsPutReady(s) == TRUE

 *

 * Input:           s       - Socket to be disconnected.

 *

 * Output:          A disconnect request is sent for given socket.

 *

 * Side Effects:    None

 *

 * Overview:        None

 *

 * Note:            None

 ********************************************************************/

void        TCPDisconnect(TCP_SOCKET s);

/*********************************************************************

 * Function:        BOOL TCPIsPutReady(TCP_SOCKET s)

 *

 * PreCondition:    TCPInit() is already called.

 *

 * Input:           s       - socket to test

 *

 * Output:          TRUE if socket 's' is free to transmit

 *                  FALSE if socket 's' is not free to transmit.

 *

 * Side Effects:    None

 *

 * Overview:        None

 *

 * Note:            Each socket maintains only transmit buffer.

 *                  Hence until a data packet is acknowledeged by

 *                  remote node, socket will not be ready for

 *                  next transmission.

 *                  All control transmission such as Connect,

 *                  Disconnect do not consume/reserve any transmit

 *                  buffer.

 ********************************************************************/

BOOL        TCPIsPutReady(TCP_SOCKET s);

/*********************************************************************

 * Function:        BOOL TCPPut(TCP_SOCKET s, BYTE byte)

 *

 * PreCondition:    TCPIsPutReady() == TRUE

 *

 * Input:           s       - socket to use

 *                  byte    - a data byte to send

 *

 * Output:          TRUE if given byte was put in transmit buffer

 *                  FALSE if transmit buffer is full.

 *

 * Side Effects:    None

 *

 * Overview:        None

 *

 * Note:            None

 ********************************************************************/

BOOL        TCPPut(TCP_SOCKET socket, BYTE byte);

/*********************************************************************

 * Function:        BOOL TCPFlush(TCP_SOCKET s)

 *

 * PreCondition:    TCPInit() is already called.

 *

 * Input:           s       - Socket whose data is to be transmitted.

 *

 * Output:          All and any data associated with this socket

 *                  is marked as ready for transmission.

 *

 * Side Effects:    None

 *

 * Overview:        None

 *

 * Note:            None

 ********************************************************************/

BOOL        TCPFlush(TCP_SOCKET socket);

/*********************************************************************

 * Function:        BOOL TCPIsGetReady(TCP_SOCKET s)

 *

 * PreCondition:    TCPInit() is already called.

 *

 * Input:           s       - socket to test

 *

 * Output:          TRUE if socket 's' contains any data.

 *                  FALSE if socket 's' does not contain any data.

 *

 * Side Effects:    None

 *

 * Overview:        None

 *

 * Note:            None

 ********************************************************************/

BOOL        TCPIsGetReady(TCP_SOCKET s);

/*********************************************************************

 * Function:        BOOL TCPGet(TCP_SOCKET s, BYTE *byte)

 *

 * PreCondition:    TCPInit() is already called     AND

 *                  TCPIsGetReady(s) == TRUE

 *

 * Input:           s       - socket

 *                  byte    - Pointer to a byte.

 *

 * Output:          TRUE if a byte was read.

 *                  FALSE if byte was not read.

 *

 * Side Effects:    None

 *

 * Overview:        None

 *

 * Note:            None

 ********************************************************************/

BOOL        TCPGet(TCP_SOCKET socket, BYTE *byte);

/*********************************************************************

 * Function:        WORD TCPGetArray(TCP_SOCKET s, BYTE *buffer,

 *                                      WORD count)

 *

 * PreCondition:    TCPInit() is already called     AND

 *                  TCPIsGetReady(s) == TRUE

 *

 * Input:           s       - socket

 *                  buffer  - Buffer to hold received data.

 *                  count   - Buffer length

 *

 * Output:          Number of bytes loaded into buffer.

 *

 * Side Effects:    None

 *

 * Overview:        None

 *

 * Note:            None

 ********************************************************************/

WORD        TCPGetArray(TCP_SOCKET s, BYTE *buffer, WORD count);

/*********************************************************************

 * Function:        BOOL TCPDiscard(TCP_SOCKET s)

 *

 * PreCondition:    TCPInit() is already called.

 *

 * Input:           s       - socket

 *

 * Output:          TRUE if socket received data was discarded

 *                  FALSE if socket received data was already

 *                          discarded.

 *

 * Side Effects:    None

 *

 * Overview:        None

 *

 * Note:            None

 ********************************************************************/

BOOL        TCPDiscard(TCP_SOCKET socket);

/*********************************************************************

 * Function:        BOOL TCPProcess(NODE_INFO* remote,

 *                                  IP_ADDR *localIP,

 *                                  WORD len)

 *

 * PreCondition:    TCPInit() is already called     AND

 *                  TCP segment is ready in MAC buffer

 *

 * Input:           remote      - Remote node info

 *                  len         - Total length of TCP semgent.

 *

 * Output:          TRUE if this function has completed its task

 *                  FALSE otherwise

 *

 * Side Effects:    None

 *

 * Overview:        None

 *

 * Note:            None

 ********************************************************************/

BOOL        TCPProcess(NODE_INFO *remote,

                       IP_ADDR *localIP,

                       WORD len);

/*********************************************************************

 * Function:        void TCPTick(void)

 *

 * PreCondition:    TCPInit() is already called.

 *

 * Input:           None

 *

 * Output:          Each socket FSM is executed for any timeout

 *                  situation.

 *

 * Side Effects:    None

 *

 * Overview:        None

 *

 * Note:            None

 ********************************************************************/

void        TCPTick(void);

#endif