2 FreeRTOS V4.0.1 - copyright (C) 2003-2006 Richard Barry.
\r
4 This file is part of the FreeRTOS distribution.
\r
6 FreeRTOS is free software; you can redistribute it and/or modify
\r
7 it under the terms of the GNU General Public License as published by
\r
8 the Free Software Foundation; either version 2 of the License, or
\r
9 (at your option) any later version.
\r
11 FreeRTOS is distributed in the hope that it will be useful,
\r
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
\r
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
\r
14 GNU General Public License for more details.
\r
16 You should have received a copy of the GNU General Public License
\r
17 along with FreeRTOS; if not, write to the Free Software
\r
18 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
\r
20 A special exception to the GPL can be applied should you wish to distribute
\r
21 a combined work that includes FreeRTOS, without being obliged to provide
\r
22 the source code for any proprietary components. See the licensing section
\r
23 of http://www.FreeRTOS.org for full details of how and when the exception
\r
26 ***************************************************************************
\r
27 See http://www.FreeRTOS.org for documentation, latest information, license
\r
28 and contact details. Please ensure to read the configuration and relevant
\r
29 port sections of the online documentation.
\r
30 ***************************************************************************
\r
36 /* Structure used to capture the I2C message details. The structure is then
\r
37 * queued for processing by the I2C ISR.
\r
39 typedef struct AN_I2C_MESSAGE
\r
41 portLONG lMessageLength; /*< How many bytes of data to send or received - excluding the buffer address. */
\r
42 unsigned portCHAR ucSlaveAddress; /*< The slave address of the WIZnet on the I2C bus. */
\r
43 unsigned portCHAR ucBufferAddressLowByte; /*< The address within the WIZnet device to which data should be read from / written to. */
\r
44 unsigned portCHAR ucBufferAddressHighByte; /*< As above, high byte. */
\r
45 xSemaphoreHandle xMessageCompleteSemaphore; /*< Contains a reference to a semaphore if the application tasks wants notifying when the message has been transacted. */
\r
46 unsigned portCHAR *pucBuffer; /*< Pointer to the buffer from where data will be read for transmission, or into which received data will be placed. */
\r
49 /* Constants to use as the ulDirection parameter of i2cMessage(). */
\r
50 #define i2cWRITE ( ( unsigned portLONG ) 0 )
\r
51 #define i2cREAD ( ( unsigned portLONG ) 1 )
\r
54 * Must be called once before any calls to i2cMessage.
\r
56 void i2cInit( void );
\r
59 * Send or receive a message over the I2C bus.
\r
61 * @param pucMessage The data to be transmitted or the buffer into which
\r
62 * received data will be placed.
\r
64 * @param lMessageLength The number of bytes to either transmit or receive.
\r
66 * @param ucSlaveAddress The slave address of the WIZNet device on the I2C bus.
\r
68 * @param usBufferAddress The address within the WIZNet device to which data is
\r
69 * either written to or read from. The WIZnet has it's
\r
70 * own Rx and Tx buffers.
\r
72 * @param ulDirection Must be either i2cWRITE or i2cREAD as #defined above.
\r
74 * @param xMessageCompleteSemaphore
\r
75 * Can be used to pass a semaphore reference if the
\r
76 * calling task want notification of when the message has
\r
77 * completed. Otherwise NULL can be passed.
\r
79 * @param xBlockTime The time to wait for a space in the message queue to
\r
80 * become available should one not be available
\r
83 void i2cMessage( const unsigned portCHAR * const pucMessage, portLONG lMessageLength, unsigned portCHAR ucSlaveAddress, unsigned portSHORT usBufferAddress, unsigned portLONG ulDirection, xSemaphoreHandle xMessageCompleteSemaphore, portTickType xBlockTime );
\r