You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
120 lines
5.9 KiB
C
120 lines
5.9 KiB
C
/*
|
|
FreeRTOS V8.0.1 - Copyright (C) 2014 Real Time Engineers Ltd.
|
|
All rights reserved
|
|
|
|
VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.
|
|
|
|
***************************************************************************
|
|
* *
|
|
* FreeRTOS provides completely free yet professionally developed, *
|
|
* robust, strictly quality controlled, supported, and cross *
|
|
* platform software that has become a de facto standard. *
|
|
* *
|
|
* Help yourself get started quickly and support the FreeRTOS *
|
|
* project by purchasing a FreeRTOS tutorial book, reference *
|
|
* manual, or both from: http://www.FreeRTOS.org/Documentation *
|
|
* *
|
|
* Thank you! *
|
|
* *
|
|
***************************************************************************
|
|
|
|
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 from the following
|
|
link: http://www.freertos.org/a00114.html
|
|
|
|
1 tab == 4 spaces!
|
|
|
|
***************************************************************************
|
|
* *
|
|
* Having a problem? Start by reading the FAQ "My application does *
|
|
* not run, what could be wrong?" *
|
|
* *
|
|
* http://www.FreeRTOS.org/FAQHelp.html *
|
|
* *
|
|
***************************************************************************
|
|
|
|
http://www.FreeRTOS.org - Documentation, books, training, latest versions,
|
|
license and Real Time Engineers Ltd. contact details.
|
|
|
|
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.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High
|
|
Integrity Systems to sell under the OpenRTOS brand. Low cost OpenRTOS
|
|
licenses offer ticketed support, indemnification and 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!
|
|
*/
|
|
|
|
#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
|
|
{
|
|
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. */
|
|
SemaphoreHandle_t xMessageCompleteSemaphore; /*< Contains a reference to a semaphore if the application tasks wants notifying when the message has been transacted. */
|
|
unsigned char *pucBuffer; /*< Pointer to the buffer from where data will be read for transmission, or into which received data will be placed. */
|
|
} xI2CMessage;
|
|
|
|
/* Constants to use as the ulDirection parameter of i2cMessage(). */
|
|
#define i2cWRITE ( ( unsigned long ) 0 )
|
|
#define i2cREAD ( ( unsigned long ) 1 )
|
|
|
|
/**
|
|
* 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.
|
|
*/
|
|
void i2cMessage( const unsigned char * const pucMessage, long lMessageLength, unsigned char ucSlaveAddress, unsigned short usBufferAddress, unsigned long ulDirection, SemaphoreHandle_t xMessageCompleteSemaphore, TickType_t xBlockTime );
|
|
|
|
#endif
|
|
|