2006-05-02 17:39:15 +08:00
/*
2016-02-19 01:11:14 +08:00
FreeRTOS V9 .0 .0 rc1 - Copyright ( C ) 2016 Real Time Engineers Ltd .
2013-10-15 03:56:47 +08:00
All rights reserved
2012-10-16 20:17:47 +08:00
2013-07-18 02:32:57 +08:00
VISIT http : //www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.
2006-05-02 17:39:15 +08:00
2009-10-05 19:10:48 +08:00
This file is part of the FreeRTOS distribution .
2006-05-02 17:39:15 +08:00
2009-10-13 19:05:41 +08:00
FreeRTOS is free software ; you can redistribute it and / or modify it under
2009-10-05 19:10:48 +08:00
the terms of the GNU General Public License ( version 2 ) as published by the
2015-10-16 22:57:00 +08:00
Free Software Foundation > > > > AND MODIFIED BY < < < < the FreeRTOS exception .
2013-02-20 02:36:58 +08:00
2015-03-22 05:03:42 +08:00
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
2014-04-24 22:26:36 +08:00
> > ! 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 . ! < <
2015-03-22 05:03:42 +08:00
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
2013-02-20 02:36:58 +08:00
FreeRTOS is distributed in the hope that it will be useful , but WITHOUT ANY
WARRANTY ; without even the implied warranty of MERCHANTABILITY or FITNESS
2014-12-22 03:09:18 +08:00
FOR A PARTICULAR PURPOSE . Full license text is available on the following
2013-07-18 02:32:57 +08:00
link : http : //www.freertos.org/a00114.html
2009-03-15 03:20:12 +08:00
2014-12-22 03:09:18 +08:00
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* *
* 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 *
* *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
2015-01-16 21:20:28 +08:00
http : //www.FreeRTOS.org/FAQHelp.html - Having a problem? Start by reading
2015-03-22 05:03:42 +08:00
the FAQ page " My application does not run, what could be wrong? " . Have you
defined configASSERT ( ) ?
2014-12-22 03:09:18 +08:00
2015-03-22 05:03:42 +08:00
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 .
2014-12-22 03:09:18 +08:00
2015-03-22 05:03:42 +08:00
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 .
2013-02-20 02:36:58 +08:00
2012-05-09 01:35:44 +08:00
http : //www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,
2013-07-18 02:32:57 +08:00
including FreeRTOS + Trace - an indispensable productivity tool , a DOS
compatible FAT file system , and our tiny thread aware UDP / IP stack .
2008-02-04 03:45:58 +08:00
2014-12-22 03:09:18 +08:00
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 .
2015-01-16 21:20:28 +08:00
http : //www.OpenRTOS.com - Real Time Engineers ltd. license FreeRTOS to High
2014-12-22 03:09:18 +08:00
Integrity Systems ltd . to sell under the OpenRTOS brand . Low cost OpenRTOS
licenses offer ticketed support , indemnification and commercial middleware .
2013-07-18 02:32:57 +08:00
http : //www.SafeRTOS.com - High Integrity Systems also provide a safety
engineered and independently SIL3 certified version for use in safety and
2013-02-20 02:36:58 +08:00
mission critical applications that require provable dependability .
2013-07-18 02:32:57 +08:00
1 tab = = 4 spaces !
2006-05-02 17:39:15 +08:00
*/
# ifndef I2C_H
# define I2C_H
/* Structure used to capture the I2C message details. The structure is then
* queued for processing by the I2C ISR .
*/
typedef struct AN_I2C_MESSAGE
{
2009-10-05 19:10:48 +08:00
long lMessageLength ; /*< How many bytes of data to send or received - excluding the buffer address. */
unsigned char ucSlaveAddress ; /*< The slave address of the WIZnet on the I2C bus. */
unsigned char ucBufferAddressLowByte ; /*< The address within the WIZnet device to which data should be read from / written to. */
unsigned char ucBufferAddressHighByte ; /*< As above, high byte. */
2014-02-11 20:04:59 +08:00
SemaphoreHandle_t xMessageCompleteSemaphore ; /*< Contains a reference to a semaphore if the application tasks wants notifying when the message has been transacted. */
2009-10-05 19:10:48 +08:00
unsigned char * pucBuffer ; /*< Pointer to the buffer from where data will be read for transmission, or into which received data will be placed. */
2006-05-02 17:39:15 +08:00
} xI2CMessage ;
/* Constants to use as the ulDirection parameter of i2cMessage(). */
2009-10-05 19:10:48 +08:00
# define i2cWRITE ( ( unsigned long ) 0 )
# define i2cREAD ( ( unsigned long ) 1 )
2006-05-02 17:39:15 +08:00
/**
* Must be called once before any calls to i2cMessage .
*/
void i2cInit ( void ) ;
/**
* Send or receive a message over the I2C bus .
*
* @ param pucMessage The data to be transmitted or the buffer into which
* received data will be placed .
*
* @ param lMessageLength The number of bytes to either transmit or receive .
*
* @ param ucSlaveAddress The slave address of the WIZNet device on the I2C bus .
*
* @ param usBufferAddress The address within the WIZNet device to which data is
* either written to or read from . The WIZnet has it ' s
* own Rx and Tx buffers .
*
* @ param ulDirection Must be either i2cWRITE or i2cREAD as # defined above .
*
* @ param xMessageCompleteSemaphore
* Can be used to pass a semaphore reference if the
* calling task want notification of when the message has
* completed . Otherwise NULL can be passed .
*
* @ param xBlockTime The time to wait for a space in the message queue to
* become available should one not be available
* immediately .
*/
2014-02-11 20:04:59 +08:00
void i2cMessage ( const unsigned char * const pucMessage , long lMessageLength , unsigned char ucSlaveAddress , unsigned short usBufferAddress , unsigned long ulDirection , SemaphoreHandle_t xMessageCompleteSemaphore , TickType_t xBlockTime ) ;
2006-05-02 17:39:15 +08:00
# endif