git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/WizNET_DEMO_GCC_ARM7/i2c.h

   1 /*\r
   2     FreeRTOS V7.6.0 - Copyright (C) 2013 Real Time Engineers Ltd. \r
   3     All rights reserved\r
   4 \r
   5     VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
   6 \r
   7     ***************************************************************************\r
   8      *                                                                       *\r
   9      *    FreeRTOS provides completely free yet professionally developed,    *\r
  10      *    robust, strictly quality controlled, supported, and cross          *\r
  11      *    platform software that has become a de facto standard.             *\r
  12      *                                                                       *\r
  13      *    Help yourself get started quickly and support the FreeRTOS         *\r
  14      *    project by purchasing a FreeRTOS tutorial book, reference          *\r
  15      *    manual, or both from: http://www.FreeRTOS.org/Documentation        *\r
  16      *                                                                       *\r
  17      *    Thank you!                                                         *\r
  18      *                                                                       *\r
  19     ***************************************************************************\r
  20 \r
  21     This file is part of the FreeRTOS distribution.\r
  22 \r
  23     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  24     the terms of the GNU General Public License (version 2) as published by the\r
  25     Free Software Foundation >>!AND MODIFIED BY!<< the FreeRTOS exception.\r
  26 \r
  27     >>! NOTE: The modification to the GPL is included to allow you to distribute\r
  28     >>! a combined work that includes FreeRTOS without being obliged to provide\r
  29     >>! the source code for proprietary components outside of the FreeRTOS\r
  30     >>! kernel.\r
  31 \r
  32     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  33     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  34     FOR A PARTICULAR PURPOSE.  Full license text is available from the following\r
  35     link: http://www.freertos.org/a00114.html\r
  36 \r
  37     1 tab == 4 spaces!\r
  38 \r
  39     ***************************************************************************\r
  40      *                                                                       *\r
  41      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  42      *    not run, what could be wrong?"                                     *\r
  43      *                                                                       *\r
  44      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  45      *                                                                       *\r
  46     ***************************************************************************\r
  47 \r
  48     http://www.FreeRTOS.org - Documentation, books, training, latest versions,\r
  49     license and Real Time Engineers Ltd. contact details.\r
  50 \r
  51     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  52     including FreeRTOS+Trace - an indispensable productivity tool, a DOS\r
  53     compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
  54 \r
  55     http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High\r
  56     Integrity Systems to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
  57     licenses offer ticketed support, indemnification and middleware.\r
  58 \r
  59     http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
  60     engineered and independently SIL3 certified version for use in safety and\r
  61     mission critical applications that require provable dependability.\r
  62 \r
  63     1 tab == 4 spaces!\r
  64 */\r
  65 \r
  66 #ifndef I2C_H\r
  67 #define I2C_H\r
  68 \r
  69 /* Structure used to capture the I2C message details.  The structure is then\r
  70  * queued for processing by the I2C ISR. \r
  71  */\r
  72 typedef struct AN_I2C_MESSAGE\r
  73 {\r
  74         long lMessageLength;                                    /*< How many bytes of data to send or received - excluding the buffer address. */\r
  75         unsigned char ucSlaveAddress;                   /*< The slave address of the WIZnet on the I2C bus. */\r
  76         unsigned char ucBufferAddressLowByte;   /*< The address within the WIZnet device to which data should be read from / written to. */\r
  77         unsigned char ucBufferAddressHighByte;  /*< As above, high byte. */\r
  78         xSemaphoreHandle xMessageCompleteSemaphore;     /*< Contains a reference to a semaphore if the application tasks wants notifying when the message has been transacted. */\r
  79         unsigned char *pucBuffer;                               /*< Pointer to the buffer from where data will be read for transmission, or into which received data will be placed. */\r
  80 } xI2CMessage;\r
  81 \r
  82 /* Constants to use as the ulDirection parameter of i2cMessage(). */\r
  83 #define i2cWRITE                                ( ( unsigned long ) 0 )\r
  84 #define i2cREAD                                 ( ( unsigned long ) 1 )\r
  85 \r
  86 /**\r
  87  * Must be called once before any calls to i2cMessage.\r
  88  */\r
  89 void i2cInit( void );\r
  90 \r
  91 /**\r
  92  * Send or receive a message over the I2C bus.\r
  93  *\r
  94  * @param pucMessage     The data to be transmitted or the buffer into which\r
  95  *                                               received data will be placed. \r
  96  *\r
  97  * @param lMessageLength The number of bytes to either transmit or receive.\r
  98  *\r
  99  * @param ucSlaveAddress The slave address of the WIZNet device on the I2C bus.\r
 100  *\r
 101  * @param usBufferAddress The address within the WIZNet device to which data is\r
 102  *                                               either written to or read from.  The WIZnet has it's\r
 103  *                                               own Rx and Tx buffers.\r
 104  *\r
 105  * @param ulDirection    Must be either i2cWRITE or i2cREAD as #defined above.\r
 106  *\r
 107  * @param xMessageCompleteSemaphore\r
 108  *                                               Can be used to pass a semaphore reference if the \r
 109  *                                               calling task want notification of when the message has\r
 110  *                                               completed.  Otherwise NULL can be passed.\r
 111  * \r
 112  * @param xBlockTime     The time to wait for a space in the message queue to \r
 113  *                                               become available should one not be available \r
 114  *                                               immediately.\r
 115  */\r
 116 void i2cMessage( const unsigned char * const pucMessage, long lMessageLength, unsigned char ucSlaveAddress, unsigned short usBufferAddress, unsigned long ulDirection, xSemaphoreHandle xMessageCompleteSemaphore, portTickType xBlockTime );\r
 117 \r
 118 #endif\r
 119 \r