FreeRTOS/Demo/lwIP_Demo_Rowley_ARM7/EMAC/SAM7_EMAC.h - third_party/github/FreeRTOS/FreeRTOS-Kernel - Git at Google

 /*
     FreeRTOS V9.0.0 - Copyright (C) 2016 Real Time Engineers Ltd.
     All rights reserved

     VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.

     This file is part of the FreeRTOS distribution.

     FreeRTOS is free software; you can redistribute it and/or modify it under
     the terms of the GNU General Public License (version 2) as published by the
     Free Software Foundation >>>> AND MODIFIED BY <<<< the FreeRTOS exception.

     ***************************************************************************
     >>!   NOTE: The modification to the GPL is included to allow you to     !<<
     >>!   distribute a combined work that includes FreeRTOS without being   !<<
     >>!   obliged to provide the source code for proprietary components     !<<
     >>!   outside of the FreeRTOS kernel.                                   !<<
     ***************************************************************************

     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY
     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
     FOR A PARTICULAR PURPOSE.  Full license text is available on the following
     link: http://www.freertos.org/a00114.html

     ***************************************************************************
      *                                                                       *
      *    FreeRTOS provides completely free yet professionally developed,    *
      *    robust, strictly quality controlled, supported, and cross          *
      *    platform software that is more than just the market leader, it     *
      *    is the industry's de facto standard.                               *
      *                                                                       *
      *    Help yourself get started quickly while simultaneously helping     *
      *    to support the FreeRTOS project by purchasing a FreeRTOS           *
      *    tutorial book, reference manual, or both:                          *
      *    http://www.FreeRTOS.org/Documentation                              *
      *                                                                       *
     ***************************************************************************

     http://www.FreeRTOS.org/FAQHelp.html - Having a problem?  Start by reading
     the FAQ page "My application does not run, what could be wrong?".  Have you
     defined configASSERT()?

     http://www.FreeRTOS.org/support - In return for receiving this top quality
     embedded software for free we request you assist our global community by
     participating in the support forum.

     http://www.FreeRTOS.org/training - Investing in training allows your team to
     be as productive as possible as early as possible.  Now you can receive
     FreeRTOS training directly from Richard Barry, CEO of Real Time Engineers
     Ltd, and the world's leading authority on the world's leading RTOS.

     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,
     including FreeRTOS+Trace - an indispensable productivity tool, a DOS
     compatible FAT file system, and our tiny thread aware UDP/IP stack.

     http://www.FreeRTOS.org/labs - Where new FreeRTOS products go to incubate.
     Come and try FreeRTOS+TCP, our new open source TCP/IP stack for FreeRTOS.

     http://www.OpenRTOS.com - Real Time Engineers ltd. license FreeRTOS to High
     Integrity Systems ltd. to sell under the OpenRTOS brand.  Low cost OpenRTOS
     licenses offer ticketed support, indemnification and commercial middleware.

     http://www.SafeRTOS.com - High Integrity Systems also provide a safety
     engineered and independently SIL3 certified version for use in safety and
     mission critical applications that require provable dependability.

     1 tab == 4 spaces!
 */

 /*
 Changes from V3.2.4

 	+ Modified the default MAC address as the one used previously was not liked
 	  by some routers.

 */

 #ifndef SAM_7_EMAC_H
 #define SAM_7_EMAC_H

 /* MAC address definition.  The MAC address must be unique on the network. */
 #define emacETHADDR0 0
 #define emacETHADDR1 0xbd
 #define emacETHADDR2 0x33
 #define emacETHADDR3 0x06
 #define emacETHADDR4 0x68
 #define emacETHADDR5 0x22

 /* The IP address being used. */
 #define emacIPADDR0 172
 #define emacIPADDR1 25
 #define emacIPADDR2 218
 #define emacIPADDR3 205

 /* The gateway address being used. */
 #define emacGATEWAY_ADDR0 172
 #define emacGATEWAY_ADDR1 25
 #define emacGATEWAY_ADDR2 218
 #define emacGATEWAY_ADDR3 3

 /* The network mask being used. */
 #define emacNET_MASK0 255
 #define emacNET_MASK1 255
 #define emacNET_MASK2 0
 #define emacNET_MASK3 0

 /*
  * Initialise the EMAC driver.  If successful a semaphore is returned that
  * is used by the EMAC ISR to indicate that Rx packets have been received.
  * If the initialisation fails then NULL is returned.
  */
 SemaphoreHandle_t xEMACInit( void );

 /*
  * Send ulLength bytes from pcFrom.  This copies the buffer to one of the
  * EMAC Tx buffers, then indicates to the EMAC that the buffer is ready.
  * If lEndOfFrame is true then the data being copied is the end of the frame
  * and the frame can be transmitted.
  */
 long lEMACSend( char *pcFrom, unsigned long ulLength, long lEndOfFrame );

 /*
  * Frames can be read from the EMAC in multiple sections.
  * Read ulSectionLength bytes from the EMAC receive buffers to pcTo.
  * ulTotalFrameLength is the size of the entire frame.  Generally vEMACRead
  * will be repetedly called until the sum of all the ulSectionLenths totals
  * the value of ulTotalFrameLength.
  */
 void vEMACRead( char *pcTo, unsigned long ulSectionLength, unsigned long ulTotalFrameLength );

 /*
  * The EMAC driver and interrupt service routines are defined in different
  * files as the driver is compiled to THUMB, and the ISR to ARM.  This function
  * simply passes the semaphore used to communicate between the two.
  */
 void vPassEMACSemaphore( SemaphoreHandle_t xCreatedSemaphore );

 /*
  * Called by the Tx interrupt, this function traverses the buffers used to
  * hold the frame that has just completed transmission and marks each as
  * free again.
  */
 void vClearEMACTxBuffer( void );

 /*
  * Suspend on a semaphore waiting either for the semaphore to be obtained
  * or a timeout.  The semaphore is used by the EMAC ISR to indicate that
  * data has been received and is ready for processing.
  */
 void vEMACWaitForInput( void );

 /*
  * Return the length of the next frame in the receive buffers.
  */
 unsigned long ulEMACInputLength( void );

 #endif
	/*
	FreeRTOS V9.0.0 - Copyright (C) 2016 Real Time Engineers Ltd.
	All rights reserved

	VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.

	This file is part of the FreeRTOS distribution.

	FreeRTOS is free software; you can redistribute it and/or modify it under
	the terms of the GNU General Public License (version 2) as published by the
	Free Software Foundation >>>> AND MODIFIED BY <<<< the FreeRTOS exception.

	***************************************************************************
	>>! NOTE: The modification to the GPL is included to allow you to !<<
	>>! distribute a combined work that includes FreeRTOS without being !<<
	>>! obliged to provide the source code for proprietary components !<<
	>>! outside of the FreeRTOS kernel. !<<
	***************************************************************************

	FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY
	WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
	FOR A PARTICULAR PURPOSE. Full license text is available on the following
	link: http://www.freertos.org/a00114.html

	***************************************************************************
	* *
	* FreeRTOS provides completely free yet professionally developed, *
	* robust, strictly quality controlled, supported, and cross *
	* platform software that is more than just the market leader, it *
	* is the industry's de facto standard. *
	* *
	* Help yourself get started quickly while simultaneously helping *
	* to support the FreeRTOS project by purchasing a FreeRTOS *
	* tutorial book, reference manual, or both: *
	* http://www.FreeRTOS.org/Documentation *
	* *
	***************************************************************************

	http://www.FreeRTOS.org/FAQHelp.html - Having a problem? Start by reading
	the FAQ page "My application does not run, what could be wrong?". Have you
	defined configASSERT()?

	http://www.FreeRTOS.org/support - In return for receiving this top quality
	embedded software for free we request you assist our global community by
	participating in the support forum.

	http://www.FreeRTOS.org/training - Investing in training allows your team to
	be as productive as possible as early as possible. Now you can receive
	FreeRTOS training directly from Richard Barry, CEO of Real Time Engineers
	Ltd, and the world's leading authority on the world's leading RTOS.

	http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,
	including FreeRTOS+Trace - an indispensable productivity tool, a DOS
	compatible FAT file system, and our tiny thread aware UDP/IP stack.

	http://www.FreeRTOS.org/labs - Where new FreeRTOS products go to incubate.
	Come and try FreeRTOS+TCP, our new open source TCP/IP stack for FreeRTOS.

	http://www.OpenRTOS.com - Real Time Engineers ltd. license FreeRTOS to High
	Integrity Systems ltd. to sell under the OpenRTOS brand. Low cost OpenRTOS
	licenses offer ticketed support, indemnification and commercial middleware.

	http://www.SafeRTOS.com - High Integrity Systems also provide a safety
	engineered and independently SIL3 certified version for use in safety and
	mission critical applications that require provable dependability.

	1 tab == 4 spaces!
	*/

	/*
	Changes from V3.2.4

	+ Modified the default MAC address as the one used previously was not liked
	by some routers.

	*/

	#ifndef SAM_7_EMAC_H
	#define SAM_7_EMAC_H

	/* MAC address definition. The MAC address must be unique on the network. */
	#define emacETHADDR0 0
	#define emacETHADDR1 0xbd
	#define emacETHADDR2 0x33
	#define emacETHADDR3 0x06
	#define emacETHADDR4 0x68
	#define emacETHADDR5 0x22

	/* The IP address being used. */
	#define emacIPADDR0 172
	#define emacIPADDR1 25
	#define emacIPADDR2 218
	#define emacIPADDR3 205

	/* The gateway address being used. */
	#define emacGATEWAY_ADDR0 172
	#define emacGATEWAY_ADDR1 25
	#define emacGATEWAY_ADDR2 218
	#define emacGATEWAY_ADDR3 3

	/* The network mask being used. */
	#define emacNET_MASK0 255
	#define emacNET_MASK1 255
	#define emacNET_MASK2 0
	#define emacNET_MASK3 0

	/*
	* Initialise the EMAC driver. If successful a semaphore is returned that
	* is used by the EMAC ISR to indicate that Rx packets have been received.
	* If the initialisation fails then NULL is returned.
	*/
	SemaphoreHandle_t xEMACInit( void );

	/*
	* Send ulLength bytes from pcFrom. This copies the buffer to one of the
	* EMAC Tx buffers, then indicates to the EMAC that the buffer is ready.
	* If lEndOfFrame is true then the data being copied is the end of the frame
	* and the frame can be transmitted.
	*/
	long lEMACSend( char *pcFrom, unsigned long ulLength, long lEndOfFrame );

	/*
	* Frames can be read from the EMAC in multiple sections.
	* Read ulSectionLength bytes from the EMAC receive buffers to pcTo.
	* ulTotalFrameLength is the size of the entire frame. Generally vEMACRead
	* will be repetedly called until the sum of all the ulSectionLenths totals
	* the value of ulTotalFrameLength.
	*/
	void vEMACRead( char *pcTo, unsigned long ulSectionLength, unsigned long ulTotalFrameLength );

	/*
	* The EMAC driver and interrupt service routines are defined in different
	* files as the driver is compiled to THUMB, and the ISR to ARM. This function
	* simply passes the semaphore used to communicate between the two.
	*/
	void vPassEMACSemaphore( SemaphoreHandle_t xCreatedSemaphore );

	/*
	* Called by the Tx interrupt, this function traverses the buffers used to
	* hold the frame that has just completed transmission and marks each as
	* free again.
	*/
	void vClearEMACTxBuffer( void );

	/*
	* Suspend on a semaphore waiting either for the semaphore to be obtained
	* or a timeout. The semaphore is used by the EMAC ISR to indicate that
	* data has been received and is ready for processing.
	*/
	void vEMACWaitForInput( void );

	/*
	* Return the length of the next frame in the receive buffers.
	*/
	unsigned long ulEMACInputLength( void );

	#endif