| 1 |
585 |
jeremybenn |
/*
|
| 2 |
|
|
FreeRTOS V6.1.1 - Copyright (C) 2011 Real Time Engineers Ltd.
|
| 3 |
|
|
|
| 4 |
|
|
***************************************************************************
|
| 5 |
|
|
* *
|
| 6 |
|
|
* If you are: *
|
| 7 |
|
|
* *
|
| 8 |
|
|
* + New to FreeRTOS, *
|
| 9 |
|
|
* + Wanting to learn FreeRTOS or multitasking in general quickly *
|
| 10 |
|
|
* + Looking for basic training, *
|
| 11 |
|
|
* + Wanting to improve your FreeRTOS skills and productivity *
|
| 12 |
|
|
* *
|
| 13 |
|
|
* then take a look at the FreeRTOS books - available as PDF or paperback *
|
| 14 |
|
|
* *
|
| 15 |
|
|
* "Using the FreeRTOS Real Time Kernel - a Practical Guide" *
|
| 16 |
|
|
* http://www.FreeRTOS.org/Documentation *
|
| 17 |
|
|
* *
|
| 18 |
|
|
* A pdf reference manual is also available. Both are usually delivered *
|
| 19 |
|
|
* to your inbox within 20 minutes to two hours when purchased between 8am *
|
| 20 |
|
|
* and 8pm GMT (although please allow up to 24 hours in case of *
|
| 21 |
|
|
* exceptional circumstances). Thank you for your support! *
|
| 22 |
|
|
* *
|
| 23 |
|
|
***************************************************************************
|
| 24 |
|
|
|
| 25 |
|
|
This file is part of the FreeRTOS distribution.
|
| 26 |
|
|
|
| 27 |
|
|
FreeRTOS is free software; you can redistribute it and/or modify it under
|
| 28 |
|
|
the terms of the GNU General Public License (version 2) as published by the
|
| 29 |
|
|
Free Software Foundation AND MODIFIED BY the FreeRTOS exception.
|
| 30 |
|
|
***NOTE*** The exception to the GPL is included to allow you to distribute
|
| 31 |
|
|
a combined work that includes FreeRTOS without being obliged to provide the
|
| 32 |
|
|
source code for proprietary components outside of the FreeRTOS kernel.
|
| 33 |
|
|
FreeRTOS is distributed in the hope that it will be useful, but WITHOUT
|
| 34 |
|
|
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
| 35 |
|
|
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
|
| 36 |
|
|
more details. You should have received a copy of the GNU General Public
|
| 37 |
|
|
License and the FreeRTOS license exception along with FreeRTOS; if not it
|
| 38 |
|
|
can be viewed here: http://www.freertos.org/a00114.html and also obtained
|
| 39 |
|
|
by writing to Richard Barry, contact details for whom are available on the
|
| 40 |
|
|
FreeRTOS WEB site.
|
| 41 |
|
|
|
| 42 |
|
|
1 tab == 4 spaces!
|
| 43 |
|
|
|
| 44 |
|
|
http://www.FreeRTOS.org - Documentation, latest information, license and
|
| 45 |
|
|
contact details.
|
| 46 |
|
|
|
| 47 |
|
|
http://www.SafeRTOS.com - A version that is certified for use in safety
|
| 48 |
|
|
critical systems.
|
| 49 |
|
|
|
| 50 |
|
|
http://www.OpenRTOS.com - Commercial support, development, porting,
|
| 51 |
|
|
licensing and training services.
|
| 52 |
|
|
*/
|
| 53 |
|
|
|
| 54 |
|
|
#ifndef I2C_H
|
| 55 |
|
|
#define I2C_H
|
| 56 |
|
|
|
| 57 |
|
|
/* Structure used to capture the I2C message details. The structure is then
|
| 58 |
|
|
* queued for processing by the I2C ISR.
|
| 59 |
|
|
*/
|
| 60 |
|
|
typedef struct AN_I2C_MESSAGE
|
| 61 |
|
|
{
|
| 62 |
|
|
long lMessageLength; /*< How many bytes of data to send or received - excluding the buffer address. */
|
| 63 |
|
|
unsigned char ucSlaveAddress; /*< The slave address of the WIZnet on the I2C bus. */
|
| 64 |
|
|
unsigned char ucBufferAddressLowByte; /*< The address within the WIZnet device to which data should be read from / written to. */
|
| 65 |
|
|
unsigned char ucBufferAddressHighByte; /*< As above, high byte. */
|
| 66 |
|
|
xSemaphoreHandle xMessageCompleteSemaphore; /*< Contains a reference to a semaphore if the application tasks wants notifying when the message has been transacted. */
|
| 67 |
|
|
unsigned char *pucBuffer; /*< Pointer to the buffer from where data will be read for transmission, or into which received data will be placed. */
|
| 68 |
|
|
} xI2CMessage;
|
| 69 |
|
|
|
| 70 |
|
|
/* Constants to use as the ulDirection parameter of i2cMessage(). */
|
| 71 |
|
|
#define i2cWRITE ( ( unsigned long ) 0 )
|
| 72 |
|
|
#define i2cREAD ( ( unsigned long ) 1 )
|
| 73 |
|
|
|
| 74 |
|
|
/**
|
| 75 |
|
|
* Must be called once before any calls to i2cMessage.
|
| 76 |
|
|
*/
|
| 77 |
|
|
void i2cInit( void );
|
| 78 |
|
|
|
| 79 |
|
|
/**
|
| 80 |
|
|
* Send or receive a message over the I2C bus.
|
| 81 |
|
|
*
|
| 82 |
|
|
* @param pucMessage The data to be transmitted or the buffer into which
|
| 83 |
|
|
* received data will be placed.
|
| 84 |
|
|
*
|
| 85 |
|
|
* @param lMessageLength The number of bytes to either transmit or receive.
|
| 86 |
|
|
*
|
| 87 |
|
|
* @param ucSlaveAddress The slave address of the WIZNet device on the I2C bus.
|
| 88 |
|
|
*
|
| 89 |
|
|
* @param usBufferAddress The address within the WIZNet device to which data is
|
| 90 |
|
|
* either written to or read from. The WIZnet has it's
|
| 91 |
|
|
* own Rx and Tx buffers.
|
| 92 |
|
|
*
|
| 93 |
|
|
* @param ulDirection Must be either i2cWRITE or i2cREAD as #defined above.
|
| 94 |
|
|
*
|
| 95 |
|
|
* @param xMessageCompleteSemaphore
|
| 96 |
|
|
* Can be used to pass a semaphore reference if the
|
| 97 |
|
|
* calling task want notification of when the message has
|
| 98 |
|
|
* completed. Otherwise NULL can be passed.
|
| 99 |
|
|
*
|
| 100 |
|
|
* @param xBlockTime The time to wait for a space in the message queue to
|
| 101 |
|
|
* become available should one not be available
|
| 102 |
|
|
* immediately.
|
| 103 |
|
|
*/
|
| 104 |
|
|
void i2cMessage( const unsigned char * const pucMessage, long lMessageLength, unsigned char ucSlaveAddress, unsigned short usBufferAddress, unsigned long ulDirection, xSemaphoreHandle xMessageCompleteSemaphore, portTickType xBlockTime );
|
| 105 |
|
|
|
| 106 |
|
|
#endif
|
| 107 |
|
|
|
