/*
 * FreeRTOS+TCP V2.3.3
 * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
 * this software and associated documentation files (the "Software"), to deal in
 * the Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 * the Software, and to permit persons to whom the Software is furnished to do so,
 * subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 * http://aws.amazon.com/freertos
 * http://www.FreeRTOS.org
 */

#ifndef FREERTOS_SOCKETS_H
    #define FREERTOS_SOCKETS_H

    #ifdef __cplusplus
        extern "C" {
    #endif

/* Standard includes. */
    #include <string.h>

/* FreeRTOS includes. */
    #include "FreeRTOS.h"
    #include "task.h"

/* Application level configuration options. */
    #include "FreeRTOSIPConfig.h"

    #ifndef FREERTOS_IP_CONFIG_H
        #error FreeRTOSIPConfig.h has not been included yet
    #endif

/* Event bit definitions are required by the select functions. */
    #include "event_groups.h"

    #ifndef INC_FREERTOS_H
        #error FreeRTOS.h must be included before FreeRTOS_Sockets.h.
    #endif

    #ifndef INC_TASK_H
        #ifndef TASK_H /* For compatibility with older FreeRTOS versions. */
            #error The FreeRTOS header file task.h must be included before FreeRTOS_Sockets.h.
        #endif
    #endif

/* Assigned to an Socket_t variable when the socket is not valid, probably
 * because it could not be created. */
    #define FREERTOS_INVALID_SOCKET    ( ( Socket_t ) ~0U )

/* API function error values.  As errno is supported, the FreeRTOS sockets
 * functions return error codes rather than just a pass or fail indication. */

/* HT: Extended the number of error codes, gave them positive values and if possible
 * the corresponding found in errno.h
 * In case of an error, API's will still return negative numbers, e.g.
 * return -pdFREERTOS_ERRNO_EWOULDBLOCK;
 * in case an operation would block */

/* The following defines are obsolete, please use -pdFREERTOS_ERRNO_Exxx */

    #define FREERTOS_SOCKET_ERROR                 ( -1 )
    #define FREERTOS_EWOULDBLOCK                  ( -pdFREERTOS_ERRNO_EWOULDBLOCK )
    #define FREERTOS_EINVAL                       ( -pdFREERTOS_ERRNO_EINVAL )
    #define FREERTOS_EADDRNOTAVAIL                ( -pdFREERTOS_ERRNO_EADDRNOTAVAIL )
    #define FREERTOS_EADDRINUSE                   ( -pdFREERTOS_ERRNO_EADDRINUSE )
    #define FREERTOS_ENOBUFS                      ( -pdFREERTOS_ERRNO_ENOBUFS )
    #define FREERTOS_ENOPROTOOPT                  ( -pdFREERTOS_ERRNO_ENOPROTOOPT )
    #define FREERTOS_ECLOSED                      ( -pdFREERTOS_ERRNO_ENOTCONN )

/* Values for the parameters to FreeRTOS_socket(), inline with the Berkeley
 * standard.  See the documentation of FreeRTOS_socket() for more information. */
    #define FREERTOS_AF_INET                      ( 2 )
    #define FREERTOS_AF_INET6                     ( 10 )
    #define FREERTOS_SOCK_DGRAM                   ( 2 )
    #define FREERTOS_IPPROTO_UDP                  ( 17 )

    #define FREERTOS_SOCK_STREAM                  ( 1 )
    #define FREERTOS_IPPROTO_TCP                  ( 6 )

/* IP packet of type "Any local network"
 * can be used in stead of TCP for testing with sockets in raw mode
 */
    #define FREERTOS_IPPROTO_USR_LAN              ( 63 )

/* A bit value that can be passed into the FreeRTOS_sendto() function as part of
 * the flags parameter.  Setting the FREERTOS_ZERO_COPY in the flags parameter
 * indicates that the zero copy interface is being used.  See the documentation for
 * FreeRTOS_sockets() for more information. */
    #define FREERTOS_ZERO_COPY                    ( 1 )

/* Values that can be passed in the option name parameter of calls to
 * FreeRTOS_setsockopt(). */
    #define FREERTOS_SO_RCVTIMEO                  ( 0 ) /* Used to set the receive time out. */
    #define FREERTOS_SO_SNDTIMEO                  ( 1 ) /* Used to set the send time out. */
    #define FREERTOS_SO_UDPCKSUM_OUT              ( 2 ) /* Used to turn the use of the UDP checksum by a socket on or off.  This also doubles as part of an 8-bit bitwise socket option. */
    #if ( ipconfigSOCKET_HAS_USER_SEMAPHORE == 1 )
        #define FREERTOS_SO_SET_SEMAPHORE         ( 3 ) /* Used to set a user's semaphore */
    #endif
    #define FREERTOS_SO_SNDBUF                    ( 4 ) /* Set the size of the send buffer (TCP only) */
    #define FREERTOS_SO_RCVBUF                    ( 5 ) /* Set the size of the receive buffer (TCP only) */

    #if ipconfigUSE_CALLBACKS == 1
        #define FREERTOS_SO_TCP_CONN_HANDLER      ( 6 )  /* Install a callback for (dis) connection events. Supply pointer to 'F_TCP_UDP_Handler_t' (see below) */
        #define FREERTOS_SO_TCP_RECV_HANDLER      ( 7 )  /* Install a callback for receiving TCP data. Supply pointer to 'F_TCP_UDP_Handler_t' (see below) */
        #define FREERTOS_SO_TCP_SENT_HANDLER      ( 8 )  /* Install a callback for sending TCP data. Supply pointer to 'F_TCP_UDP_Handler_t' (see below) */
        #define FREERTOS_SO_UDP_RECV_HANDLER      ( 9 )  /* Install a callback for receiving UDP data. Supply pointer to 'F_TCP_UDP_Handler_t' (see below) */
        #define FREERTOS_SO_UDP_SENT_HANDLER      ( 10 ) /* Install a callback for sending UDP data. Supply pointer to 'F_TCP_UDP_Handler_t' (see below) */
    #endif /* ipconfigUSE_CALLBACKS */

    #define FREERTOS_SO_REUSE_LISTEN_SOCKET       ( 11 ) /* When a listening socket gets connected, do not create a new one but re-use it */
    #define FREERTOS_SO_CLOSE_AFTER_SEND          ( 12 ) /* As soon as the last byte has been transmitted, finalise the connection */
    #define FREERTOS_SO_WIN_PROPERTIES            ( 13 ) /* Set all buffer and window properties in one call, parameter is pointer to WinProperties_t */
    #define FREERTOS_SO_SET_FULL_SIZE             ( 14 ) /* Refuse to send packets smaller than MSS  */

    #define FREERTOS_SO_STOP_RX                   ( 15 ) /* Temporarily hold up reception, used by streaming client */

    #if ( ipconfigUDP_MAX_RX_PACKETS > 0 )
        #define FREERTOS_SO_UDP_MAX_RX_PACKETS    ( 16 ) /* This option helps to limit the maximum number of packets a UDP socket will buffer */
    #endif

    #if ( ipconfigSOCKET_HAS_USER_WAKE_CALLBACK == 1 )
        #define FREERTOS_SO_WAKEUP_CALLBACK           ( 17 )
    #endif

    #define FREERTOS_SO_SET_LOW_HIGH_WATER            ( 18 )

    #define FREERTOS_NOT_LAST_IN_FRAGMENTED_PACKET    ( 0x80 ) /* For internal use only, but also part of an 8-bit bitwise value. */
    #define FREERTOS_FRAGMENTED_PACKET                ( 0x40 ) /* For internal use only, but also part of an 8-bit bitwise value. */

/* Values for flag for FreeRTOS_shutdown(). */
    #define FREERTOS_SHUT_RD                          ( 0 ) /* Not really at this moment, just for compatibility of the interface */
    #define FREERTOS_SHUT_WR                          ( 1 )
    #define FREERTOS_SHUT_RDWR                        ( 2 )

/* Values for flag for FreeRTOS_recv(). */
    #define FREERTOS_MSG_OOB                          ( 2 )  /* process out-of-band data */
    #define FREERTOS_MSG_PEEK                         ( 4 )  /* peek at incoming message */
    #define FREERTOS_MSG_DONTROUTE                    ( 8 )  /* send without using routing tables */
    #define FREERTOS_MSG_DONTWAIT                     ( 16 ) /* Can be used with recvfrom(), sendto(), recv(), and send(). */


/**
 * Structure to hold the properties of Tx/Rx buffers and windows.
 */
    typedef struct xWIN_PROPS
    {
        /* Properties of the Tx buffer and Tx window */
        int32_t lTxBufSize; /**< Unit: bytes */
        int32_t lTxWinSize; /**< Unit: MSS */

        /* Properties of the Rx buffer and Rx window */
        int32_t lRxBufSize; /**< Unit: bytes */
        int32_t lRxWinSize; /**< Unit: MSS */
    } WinProperties_t;

/**
 * Structure to pass for the 'FREERTOS_SO_SET_LOW_HIGH_WATER' option
 */
    typedef struct xLOW_HIGH_WATER
    {
        size_t uxLittleSpace; /**< Send a STOP when buffer space drops below X bytes */
        size_t uxEnoughSpace; /**< Send a GO when buffer space grows above X bytes */
    } LowHighWater_t;

/* For compatibility with the expected Berkeley sockets naming. */
    #define socklen_t    uint32_t

/**
 * For this limited implementation, only two members are required in the
 * Berkeley style sockaddr structure.
 */
    struct freertos_sockaddr
    {
        /* _HT_ On 32- and 64-bit architectures, the addition of the two uint8_t
         * fields doesn't make the structure bigger, due to alignment.
         * The fields are inserted as a preparation for IPv6. */

        /* sin_len and sin_family not used in the IPv4-only release. */
        uint8_t sin_len;    /**< length of this structure. */
        uint8_t sin_family; /**< FREERTOS_AF_INET. */
        uint16_t sin_port;  /**< The port */
        uint32_t sin_addr;  /**< The IP address */
    };


    extern const char * FreeRTOS_inet_ntoa( uint32_t ulIPAddress,
                                            char * pcBuffer );

    #if ipconfigBYTE_ORDER == pdFREERTOS_LITTLE_ENDIAN

        #define FreeRTOS_inet_addr_quick( ucOctet0, ucOctet1, ucOctet2, ucOctet3 ) \
    ( ( ( ( uint32_t ) ( ucOctet3 ) ) << 24UL ) |                                  \
      ( ( ( uint32_t ) ( ucOctet2 ) ) << 16UL ) |                                  \
      ( ( ( uint32_t ) ( ucOctet1 ) ) << 8UL ) |                                   \
      ( ( uint32_t ) ( ucOctet0 ) ) )

    #else /* ipconfigBYTE_ORDER */

        #define FreeRTOS_inet_addr_quick( ucOctet0, ucOctet1, ucOctet2, ucOctet3 ) \
    ( ( ( ( uint32_t ) ( ucOctet0 ) ) << 24UL ) |                                  \
      ( ( ( uint32_t ) ( ucOctet1 ) ) << 16UL ) |                                  \
      ( ( ( uint32_t ) ( ucOctet2 ) ) << 8UL ) |                                   \
      ( ( uint32_t ) ( ucOctet3 ) ) )

    #endif /* ipconfigBYTE_ORDER */

/* The socket type itself. */
    struct xSOCKET;
    typedef struct xSOCKET         * Socket_t;
    typedef struct xSOCKET const   * ConstSocket_t;

    extern BaseType_t xSocketValid( Socket_t xSocket );

    #if ( ipconfigSUPPORT_SELECT_FUNCTION == 1 )

/* The SocketSet_t type is the equivalent to the fd_set type used by the
 * Berkeley API. */
        struct xSOCKET_SET;
        typedef struct xSOCKET_SET * SocketSet_t;
    #endif /* ( ipconfigSUPPORT_SELECT_FUNCTION == 1 ) */

/**
 * FULL, UP-TO-DATE AND MAINTAINED REFERENCE DOCUMENTATION FOR ALL THESE
 * FUNCTIONS IS AVAILABLE ON THE FOLLOWING URL:
 * http://www.FreeRTOS.org/FreeRTOS-Plus/FreeRTOS_Plus_TCP/FreeRTOS_TCP_API_Functions.html
 */
    Socket_t FreeRTOS_socket( BaseType_t xDomain,
                              BaseType_t xType,
                              BaseType_t xProtocol );
    int32_t FreeRTOS_recvfrom( Socket_t xSocket,
                               void * pvBuffer,
                               size_t uxBufferLength,
                               BaseType_t xFlags,
                               struct freertos_sockaddr * pxSourceAddress,
                               socklen_t * pxSourceAddressLength );
    int32_t FreeRTOS_sendto( Socket_t xSocket,
                             const void * pvBuffer,
                             size_t uxTotalDataLength,
                             BaseType_t xFlags,
                             const struct freertos_sockaddr * pxDestinationAddress,
                             socklen_t xDestinationAddressLength );
    BaseType_t FreeRTOS_bind( Socket_t xSocket,
                              struct freertos_sockaddr const * pxAddress,
                              socklen_t xAddressLength );

/* function to get the local address and IP port */
    size_t FreeRTOS_GetLocalAddress( ConstSocket_t xSocket,
                                     struct freertos_sockaddr * pxAddress );

    #if ( ipconfigETHERNET_DRIVER_FILTERS_PACKETS == 1 )
        /* Returns true if an UDP socket exists bound to mentioned port number. */
        BaseType_t xPortHasUDPSocket( uint16_t usPortNr );
    #endif

    #if ipconfigUSE_TCP == 1

        BaseType_t FreeRTOS_connect( Socket_t xClientSocket,
                                     struct freertos_sockaddr * pxAddress,
                                     socklen_t xAddressLength );
        BaseType_t FreeRTOS_listen( Socket_t xSocket,
                                    BaseType_t xBacklog );
        BaseType_t FreeRTOS_recv( Socket_t xSocket,
                                  void * pvBuffer,
                                  size_t uxBufferLength,
                                  BaseType_t xFlags );
        BaseType_t FreeRTOS_send( Socket_t xSocket,
                                  const void * pvBuffer,
                                  size_t uxDataLength,
                                  BaseType_t xFlags );
        Socket_t FreeRTOS_accept( Socket_t xServerSocket,
                                  struct freertos_sockaddr * pxAddress,
                                  socklen_t * pxAddressLength );
        BaseType_t FreeRTOS_shutdown( Socket_t xSocket,
                                      BaseType_t xHow );

        #if ( ipconfigSUPPORT_SIGNALS != 0 )
            /* Send a signal to the task which is waiting for a given socket. */
            BaseType_t FreeRTOS_SignalSocket( Socket_t xSocket );

/* Send a signal to the task which reads from this socket (FromISR
 * version). */
            BaseType_t FreeRTOS_SignalSocketFromISR( Socket_t xSocket,
                                                     BaseType_t * pxHigherPriorityTaskWoken );
        #endif /* ipconfigSUPPORT_SIGNALS */

/* Return the remote address and IP port. */
        BaseType_t FreeRTOS_GetRemoteAddress( ConstSocket_t xSocket,
                                              struct freertos_sockaddr * pxAddress );

        #if ( ipconfigUSE_TCP == 1 )

/* Returns pdTRUE if TCP socket is connected. */
            BaseType_t FreeRTOS_issocketconnected( ConstSocket_t xSocket );

/* Returns the actual size of MSS being used. */
            BaseType_t FreeRTOS_mss( ConstSocket_t xSocket );

        #endif /* ( ipconfigUSE_TCP == 1 ) */

/* For internal use only: return the connection status. */
        BaseType_t FreeRTOS_connstatus( ConstSocket_t xSocket );

/* Returns the number of bytes that may be added to txStream */
        BaseType_t FreeRTOS_maywrite( ConstSocket_t xSocket );

/*
 * Two helper functions, mostly for testing
 * rx_size returns the number of bytes available in the Rx buffer
 * tx_space returns the free space in the Tx buffer
 */
        #if ( ipconfigUSE_TCP == 1 )
            BaseType_t FreeRTOS_rx_size( ConstSocket_t xSocket );
            BaseType_t FreeRTOS_tx_space( ConstSocket_t xSocket );
            BaseType_t FreeRTOS_tx_size( ConstSocket_t xSocket );
        #endif

/* Returns the number of outstanding bytes in txStream. */

/* The function FreeRTOS_outstanding() was already implemented
 * FreeRTOS_tx_size(). */
        #define FreeRTOS_outstanding( xSocket )    FreeRTOS_tx_size( xSocket )

/* Returns the number of bytes in the socket's rxStream. */

/* The function FreeRTOS_recvcount() was already implemented
 * FreeRTOS_rx_size(). */
        #define FreeRTOS_recvcount( xSocket )    FreeRTOS_rx_size( xSocket )

/*
 * For advanced applications only:
 * Get a direct pointer to the circular transmit buffer.
 * '*pxLength' will contain the number of bytes that may be written.
 */
        uint8_t * FreeRTOS_get_tx_head( ConstSocket_t xSocket,
                                        BaseType_t * pxLength );

    #endif /* ipconfigUSE_TCP */

    #if ( ipconfigUSE_CALLBACKS != 0 )

/*
 * Connect / disconnect handler for a TCP socket
 * For example:
 *       static void vMyConnectHandler (Socket_t xSocket, BaseType_t ulConnected)
 *       {
 *       }
 *       F_TCP_UDP_Handler_t xHnd = { vMyConnectHandler };
 *       FreeRTOS_setsockopt( sock, 0, FREERTOS_SO_TCP_CONN_HANDLER, ( void * ) &xHnd, sizeof( xHnd ) );
 */

        #ifdef __COVERITY__
            typedef void (* FOnConnected_t )( Socket_t xSocket,
                                              BaseType_t ulConnected );
        #else
            typedef void (* FOnConnected_t )( Socket_t,
                                              BaseType_t );
        #endif

/*
 * Reception handler for a TCP socket
 * A user-proved function will be called on reception of a message
 * If the handler returns a positive number, the messages will not be stored
 * For example:
 *    static BaseType_t xOnTCPReceive( Socket_t xSocket, void * pData, size_t uxLength )
 *    {
 *        // handle the message
 *        return 1;
 *    }
 *    F_TCP_UDP_Handler_t xHand = { xOnTCPReceive };
 *    FreeRTOS_setsockopt( sock, 0, FREERTOS_SO_TCP_RECV_HANDLER, ( void * ) &xHand, sizeof( xHand ) );
 */
        #ifdef __COVERITY__
            typedef BaseType_t (* FOnTCPReceive_t )( Socket_t xSocket,
                                                     void * pData,
                                                     size_t xLength );
            typedef void (* FOnTCPSent_t )( Socket_t xSocket,
                                            size_t xLength );
        #else
            typedef BaseType_t (* FOnTCPReceive_t )( Socket_t,
                                                     void *,
                                                     size_t );
            typedef void (* FOnTCPSent_t )( Socket_t,
                                            size_t );
        #endif /* ifdef __COVERITY__ */

/*
 * Reception handler for a UDP socket
 * A user-proved function will be called on reception of a message
 * If the handler returns a positive number, the messages will not be stored
 */
        #ifdef __COVERITY__
            typedef BaseType_t (* FOnUDPReceive_t ) ( Socket_t xSocket,
                                                      void * pData,
                                                      size_t xLength,
                                                      const struct freertos_sockaddr * pxFrom,
                                                      const struct freertos_sockaddr * pxDest );
            typedef void (* FOnUDPSent_t )( Socket_t xSocket,
                                            size_t xLength );
        #else
            typedef BaseType_t (* FOnUDPReceive_t ) ( Socket_t,
                                                      void *,
                                                      size_t,
                                                      const struct freertos_sockaddr *,
                                                      const struct freertos_sockaddr * );
            typedef void (* FOnUDPSent_t )( Socket_t,
                                            size_t );
        #endif /* ifdef __COVERITY__ */

        typedef union xTCP_UDP_HANDLER
        {
            FOnConnected_t pxOnTCPConnected; /* FREERTOS_SO_TCP_CONN_HANDLER */
            FOnTCPReceive_t pxOnTCPReceive;  /* FREERTOS_SO_TCP_RECV_HANDLER */
            FOnTCPSent_t pxOnTCPSent;        /* FREERTOS_SO_TCP_SENT_HANDLER */
            FOnUDPReceive_t pxOnUDPReceive;  /* FREERTOS_SO_UDP_RECV_HANDLER */
            FOnUDPSent_t pxOnUDPSent;        /* FREERTOS_SO_UDP_SENT_HANDLER */
        } F_TCP_UDP_Handler_t;
    #endif /* ( ipconfigUSE_CALLBACKS != 0 ) */

    BaseType_t FreeRTOS_setsockopt( Socket_t xSocket,
                                    int32_t lLevel,
                                    int32_t lOptionName,
                                    const void * pvOptionValue,
                                    size_t uxOptionLength );
    BaseType_t FreeRTOS_closesocket( Socket_t xSocket );

/* The following function header should be placed in FreeRTOS_DNS.h.
 * It is kept here because some applications  expect it in FreeRTOS_Sockets.h.*/
    #ifndef __COVERITY__
        uint32_t FreeRTOS_gethostbyname( const char * pcHostName );
    #endif

    BaseType_t FreeRTOS_inet_pton( BaseType_t xAddressFamily,
                                   const char * pcSource,
                                   void * pvDestination );
    const char * FreeRTOS_inet_ntop( BaseType_t xAddressFamily,
                                     const void * pvSource,
                                     char * pcDestination,
                                     socklen_t uxSize );

/* Convert a null-terminated string in dot-decimal-notation (d.d.d.d) to a 32-bit unsigned integer. */
    uint32_t FreeRTOS_inet_addr( const char * pcIPAddress );

    BaseType_t FreeRTOS_inet_pton4( const char * pcSource,
                                    void * pvDestination );
    const char * FreeRTOS_inet_ntop4( const void * pvSource,
                                      char * pcDestination,
                                      socklen_t uxSize );


/*
 * For the web server: borrow the circular Rx buffer for inspection
 * HTML driver wants to see if a sequence of 13/10/13/10 is available
 */
    const struct xSTREAM_BUFFER * FreeRTOS_get_rx_buf( ConstSocket_t xSocket );

    void FreeRTOS_netstat( void );

    #if ipconfigSUPPORT_SELECT_FUNCTION == 1

/* For FD_SET and FD_CLR, a combination of the following bits can be used: */

        typedef enum eSELECT_EVENT
        {
            eSELECT_READ = 0x0001,
            eSELECT_WRITE = 0x0002,
            eSELECT_EXCEPT = 0x0004,
            eSELECT_INTR = 0x0008,
            eSELECT_ALL = 0x000F,
            /* Reserved for internal use: */
            eSELECT_CALL_IP = 0x0010,
            /* end */
        } eSelectEvent_t;

        SocketSet_t FreeRTOS_CreateSocketSet( void );
        void FreeRTOS_DeleteSocketSet( SocketSet_t xSocketSet );
        void FreeRTOS_FD_SET( Socket_t xSocket,
                              SocketSet_t xSocketSet,
                              EventBits_t xBitsToSet );
        void FreeRTOS_FD_CLR( Socket_t xSocket,
                              SocketSet_t xSocketSet,
                              EventBits_t xBitsToClear );
        EventBits_t FreeRTOS_FD_ISSET( Socket_t xSocket,
                                       SocketSet_t xSocketSet );
        BaseType_t FreeRTOS_select( SocketSet_t xSocketSet,
                                    TickType_t xBlockTimeTicks );

    #endif /* ipconfigSUPPORT_SELECT_FUNCTION */

    #ifdef __cplusplus
        } /* extern "C" */
    #endif

#endif /* FREERTOS_SOCKETS_H */
