fnet_stack.h

/**************************************************************************
*
* Copyright 2008-2018 by Andrey Butok. FNET Community
*
***************************************************************************
*
*  Licensed under the Apache License, Version 2.0 (the "License"); you may
*  not use this file except in compliance with the License.
*  You may obtain a copy of the License at
*
*  http://www.apache.org/licenses/LICENSE-2.0
*
*  Unless required by applicable law or agreed to in writing, software
*  distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
*  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
*  See the License for the specific language governing permissions and
*  limitations under the License.
*
***************************************************************************
*
*  Main including header for the FNET TCP/IP stack.
*
***************************************************************************/

#ifndef _FNET_STACK_H_

#define _FNET_STACK_H_

#include "fnet_assert.h"
#include "fnet_error.h"
#include "fnet_stdlib.h"
#include "fnet_socket.h"
#include "fnet_inet.h"
#include "fnet_ip4.h"
#include "fnet_ip6.h"
#include "fnet_netif.h"
#include "fnet_timer.h"
#include "fnet_debug.h"
#include "fnet_eth.h"
#include "fnet_wifi.h"
#include "fnet_isr.h"
#include "fnet_netbuf.h"
#include "fnet_arp.h"
#include "fnet_checksum.h"

#if FNET_CFG_MULTITHREADING || defined(__DOXYGEN__)

/**************************************************************************/ 
typedef void *fnet_mutex_t;

/**************************************************************************/ 
typedef struct
{
    fnet_return_t (*mutex_init)( fnet_mutex_t * );  
    void (*mutex_release)( fnet_mutex_t * );        
    void (*mutex_lock)( fnet_mutex_t * );           
    void (*mutex_unlock)( fnet_mutex_t * );         
} fnet_mutex_api_t;
#endif /* FNET_CFG_MULTITHREADING */

#if FNET_CFG_TIMER_ALT || defined(__DOXYGEN__)

/**************************************************************************/ 
typedef struct
{
    fnet_time_t (*timer_get_ms)(void);             
    void (*timer_delay)(fnet_time_t delay_ms);     
} fnet_timer_api_t;
#endif /* FNET_CFG_TIMER_ALT */

/**************************************************************************/ 
struct fnet_init_params
{
    void                        *netheap_ptr;   
    fnet_size_t                 netheap_size;   
#if FNET_CFG_MULTITHREADING || defined(__DOXYGEN__)
    const fnet_mutex_api_t      *mutex_api;    
#endif
#if FNET_CFG_TIMER_ALT || defined(__DOXYGEN__)
    const fnet_timer_api_t      *timer_api;    
#endif
};

#if defined(__cplusplus)
extern "C" {
#endif

/***************************************************************************/ 
fnet_return_t fnet_init( struct fnet_init_params *init_params );

/***************************************************************************/ 
void fnet_release(void);

/***************************************************************************/ 
void fnet_poll(void);

#if defined(__cplusplus)
}
#endif

#endif /* _FNET_STACK_H_ */