Skip to content

User hook function for handling unsupported Ethernet frames #200

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Mar 4, 2021
Merged

User hook function for handling unsupported Ethernet frames #200

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
14116dc
Adds an optional user hook that gets called for all unhandled Etherne…
Mar 1, 2021
dcc0c6a
re-wording
Mar 1, 2021
963de0d
Fix spell check
AniruddhaKanhere Mar 2, 2021
de023a2
Merge branch 'main' into custom_protocols_for_pr
AniruddhaKanhere Mar 4, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/lexicon.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,7 @@ dw
dword
dzpq
eagain
eapplicationprocesscustomframehook
earpcachehit
earpcachemiss
earptimerevent
Expand Down
24 changes: 22 additions & 2 deletions FreeRTOS_IP.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,21 @@ static void prvIPTask( void * pvParameters );
*/
static void prvProcessEthernetPacket( NetworkBufferDescriptor_t * const pxNetworkBuffer );

#if ( ipconfigPROCESS_CUSTOM_ETHERNET_FRAMES != 0 )

/*
* The stack will call this user hook for all Ethernet frames that it
* does not support, i.e. other than IPv4, IPv6 and ARP ( for the moment )
* If this hook returns eReleaseBuffer or eProcessBuffer, the stack will
* release and reuse the network buffer. If this hook returns
* eReturnEthernetFrame, that means user code has reused the network buffer
* to generate a response and the stack will send that response out.
* If this hook returns eFrameConsumed, the user code has ownership of the
* network buffer and has to release it when it’s done.
*/
extern eFrameProcessingResult_t eApplicationProcessCustomFrameHook( NetworkBufferDescriptor_t * const pxNetworkBuffer );
#endif /* ( ipconfigPROCESS_CUSTOM_ETHERNET_FRAMES != 0 ) */
Copy link
Contributor

@htibosch htibosch Mar 2, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello @evpopov , thanks for this PR. It extends the possibilities of the stack without adding any real code.
As we already have discussed it on the FreeRTOS forum, and I think it is good.


/*
* Process incoming IP packets.
*/
Expand Down Expand Up @@ -1727,8 +1742,13 @@ static void prvProcessEthernetPacket( NetworkBufferDescriptor_t * const pxNetwor
break;

default:
/* No other packet types are handled. Nothing to do. */
eReturned = eReleaseBuffer;
#if ( ipconfigPROCESS_CUSTOM_ETHERNET_FRAMES != 0 )
/* Custom frame handler. */
eReturned = eApplicationProcessCustomFrameHook( pxNetworkBuffer );
#else
/* No other packet types are handled. Nothing to do. */
eReturned = eReleaseBuffer;
#endif
break;
}
}
Expand Down
8 changes: 8 additions & 0 deletions include/FreeRTOSIPConfigDefaults.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -633,4 +633,12 @@
#define ipconfigSELECT_USES_NOTIFY 0
#endif

/* Set to 1 if you plan on processing custom Ethernet protocols or protocols
* that are not yet supported by the FreeRTOS+TCP stack. If set to 1,
* the user must define eFrameProcessingResult_t eApplicationProcessCustomFrameHook( NetworkBufferDescriptor_t * const pxNetworkBuffer )
* which will be called by the stack for any frame with an unsupported EtherType. */
#ifndef ipconfigPROCESS_CUSTOM_ETHERNET_FRAMES
#define ipconfigPROCESS_CUSTOM_ETHERNET_FRAMES 0
#endif

#endif /* FREERTOS_DEFAULT_IP_CONFIG_H */