2 FreeRTOS.org V5.2.0 - Copyright (C) 2003-2009 Richard Barry.
\r
4 This file is part of the FreeRTOS.org distribution.
\r
6 FreeRTOS.org is free software; you can redistribute it and/or modify it
\r
7 under the terms of the GNU General Public License (version 2) as published
\r
8 by the Free Software Foundation and modified by the FreeRTOS exception.
\r
10 FreeRTOS.org is distributed in the hope that it will be useful, but WITHOUT
\r
11 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
\r
12 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
\r
15 You should have received a copy of the GNU General Public License along
\r
16 with FreeRTOS.org; if not, write to the Free Software Foundation, Inc., 59
\r
17 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
\r
19 A special exception to the GPL is included to allow you to distribute a
\r
20 combined work that includes FreeRTOS.org without being obliged to provide
\r
21 the source code for any proprietary components. See the licensing section
\r
22 of http://www.FreeRTOS.org for full details.
\r
25 ***************************************************************************
\r
27 * Get the FreeRTOS eBook! See http://www.FreeRTOS.org/Documentation *
\r
29 * This is a concise, step by step, 'hands on' guide that describes both *
\r
30 * general multitasking concepts and FreeRTOS specifics. It presents and *
\r
31 * explains numerous examples that are written using the FreeRTOS API. *
\r
32 * Full source code for all the examples is provided in an accompanying *
\r
35 ***************************************************************************
\r
39 Please ensure to read the configuration and relevant port sections of the
\r
40 online documentation.
\r
42 http://www.FreeRTOS.org - Documentation, latest information, license and
\r
45 http://www.SafeRTOS.com - A version that is certified for use in safety
\r
48 http://www.OpenRTOS.com - Commercial support, development, porting,
\r
49 licensing and training services.
\r
55 /* Structure used to capture the I2C message details. The structure is then
\r
56 * queued for processing by the I2C ISR.
\r
58 typedef struct AN_I2C_MESSAGE
\r
60 portLONG lMessageLength; /*< How many bytes of data to send or received - excluding the buffer address. */
\r
61 unsigned portCHAR ucSlaveAddress; /*< The slave address of the WIZnet on the I2C bus. */
\r
62 unsigned portCHAR ucBufferAddressLowByte; /*< The address within the WIZnet device to which data should be read from / written to. */
\r
63 unsigned portCHAR ucBufferAddressHighByte; /*< As above, high byte. */
\r
64 xSemaphoreHandle xMessageCompleteSemaphore; /*< Contains a reference to a semaphore if the application tasks wants notifying when the message has been transacted. */
\r
65 unsigned portCHAR *pucBuffer; /*< Pointer to the buffer from where data will be read for transmission, or into which received data will be placed. */
\r
68 /* Constants to use as the ulDirection parameter of i2cMessage(). */
\r
69 #define i2cWRITE ( ( unsigned portLONG ) 0 )
\r
70 #define i2cREAD ( ( unsigned portLONG ) 1 )
\r
73 * Must be called once before any calls to i2cMessage.
\r
75 void i2cInit( void );
\r
78 * Send or receive a message over the I2C bus.
\r
80 * @param pucMessage The data to be transmitted or the buffer into which
\r
81 * received data will be placed.
\r
83 * @param lMessageLength The number of bytes to either transmit or receive.
\r
85 * @param ucSlaveAddress The slave address of the WIZNet device on the I2C bus.
\r
87 * @param usBufferAddress The address within the WIZNet device to which data is
\r
88 * either written to or read from. The WIZnet has it's
\r
89 * own Rx and Tx buffers.
\r
91 * @param ulDirection Must be either i2cWRITE or i2cREAD as #defined above.
\r
93 * @param xMessageCompleteSemaphore
\r
94 * Can be used to pass a semaphore reference if the
\r
95 * calling task want notification of when the message has
\r
96 * completed. Otherwise NULL can be passed.
\r
98 * @param xBlockTime The time to wait for a space in the message queue to
\r
99 * become available should one not be available
\r
102 void i2cMessage( const unsigned portCHAR * const pucMessage, portLONG lMessageLength, unsigned portCHAR ucSlaveAddress, unsigned portSHORT usBufferAddress, unsigned portLONG ulDirection, xSemaphoreHandle xMessageCompleteSemaphore, portTickType xBlockTime );
\r