xref: /FreeRTOS-Plus-TCP-v4.0.0/source/portable/NetworkInterface/board_family/NetworkInterface.c (revision 1ab6eb88857cf1011bf1f8349b43a1c34c7ced0f) 
1 /*
2  * FreeRTOS+TCP <DEVELOPMENT BRANCH>
3  * Copyright (C) 2022 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
4  *
5  * SPDX-License-Identifier: MIT
6  *
7  * Permission is hereby granted, free of charge, to any person obtaining a copy of
8  * this software and associated documentation files (the "Software"), to deal in
9  * the Software without restriction, including without limitation the rights to
10  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
11  * the Software, and to permit persons to whom the Software is furnished to do so,
12  * subject to the following conditions:
13  *
14  * The above copyright notice and this permission notice shall be included in all
15  * copies or substantial portions of the Software.
16  *
17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
19  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
20  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
21  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
22  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
23  *
24  * http://aws.amazon.com/freertos
25  * http://www.FreeRTOS.org
26  */
27 
28 /*****************************************************************************
29 * Note: This file is Not! to be used as is. The purpose of this file is to provide
30 * a template for writing a network interface. Each network interface will have to provide
31 * concrete implementations of the functions in this file.
32 *
33 * See the following URL for an explanation of this file and its functions:
34 * https://freertos.org/FreeRTOS-Plus/FreeRTOS_Plus_TCP/Embedded_Ethernet_Porting.html
35 *
36 *****************************************************************************/
37 
38 /* FreeRTOS includes. */
39 #include "FreeRTOS.h"
40 #include "list.h"
41 
42 /* FreeRTOS+TCP includes. */
43 #include "FreeRTOS_IP.h"
44 
45 /* If ipconfigETHERNET_DRIVER_FILTERS_FRAME_TYPES is set to 1, then the Ethernet
46  * driver will filter incoming packets and only pass the stack those packets it
47  * considers need processing. */
48 #if ( ipconfigETHERNET_DRIVER_FILTERS_FRAME_TYPES == 0 )
49     #define ipCONSIDER_FRAME_FOR_PROCESSING( pucEthernetBuffer )    eProcessBuffer
50 #else
51     #define ipCONSIDER_FRAME_FOR_PROCESSING( pucEthernetBuffer )    eConsiderFrameForProcessing( ( pucEthernetBuffer ) )
52 #endif
53 
xNetworkInterfaceInitialise(void)54 BaseType_t xNetworkInterfaceInitialise( void )
55 {
56     /* FIX ME. */
57     return pdFALSE;
58 }
59 
xNetworkInterfaceOutput(NetworkBufferDescriptor_t * const pxNetworkBuffer,BaseType_t xReleaseAfterSend)60 BaseType_t xNetworkInterfaceOutput( NetworkBufferDescriptor_t * const pxNetworkBuffer,
61                                     BaseType_t xReleaseAfterSend )
62 {
63     /* FIX ME. */
64     return pdFALSE;
65 }
66 
vNetworkInterfaceAllocateRAMToBuffers(NetworkBufferDescriptor_t pxNetworkBuffers[ipconfigNUM_NETWORK_BUFFER_DESCRIPTORS])67 void vNetworkInterfaceAllocateRAMToBuffers( NetworkBufferDescriptor_t pxNetworkBuffers[ ipconfigNUM_NETWORK_BUFFER_DESCRIPTORS ] )
68 {
69     /* FIX ME. */
70 }
71 
xGetPhyLinkStatus(void)72 BaseType_t xGetPhyLinkStatus( void )
73 {
74     /* FIX ME. */
75     return pdFALSE;
76 }
77