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

   1 /*\r
   2         FreeRTOS.org V4.5.0 - Copyright (C) 2003-2007 Richard Barry.\r
   3 \r
   4         This file is part of the FreeRTOS.org distribution.\r
   5 \r
   6         FreeRTOS.org 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
  10 \r
  11         FreeRTOS.org 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
  15 \r
  16         You should have received a copy of the GNU General Public License\r
  17         along with FreeRTOS.org; if not, write to the Free Software\r
  18         Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA\r
  19 \r
  20         A special exception to the GPL can be applied should you wish to distribute\r
  21         a combined work that includes FreeRTOS.org, 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
  24         can be applied.\r
  25 \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
  31         Also see http://www.SafeRTOS.com for an IEC 61508 compliant version along\r
  32         with commercial development and support options.\r
  33         ***************************************************************************\r
  34 */\r
  35 \r
  36 #ifndef I2C_H\r
  37 #define I2C_H\r
  38 \r
  39 /* Structure used to capture the I2C message details.  The structure is then\r
  40  * queued for processing by the I2C ISR. \r
  41  */\r
  42 typedef struct AN_I2C_MESSAGE\r
  43 {\r
  44         portLONG lMessageLength;                                        /*< How many bytes of data to send or received - excluding the buffer address. */\r
  45         unsigned portCHAR ucSlaveAddress;                       /*< The slave address of the WIZnet on the I2C bus. */\r
  46         unsigned portCHAR ucBufferAddressLowByte;       /*< The address within the WIZnet device to which data should be read from / written to. */\r
  47         unsigned portCHAR ucBufferAddressHighByte;      /*< As above, high byte. */\r
  48         xSemaphoreHandle xMessageCompleteSemaphore;     /*< Contains a reference to a semaphore if the application tasks wants notifying when the message has been transacted. */\r
  49         unsigned portCHAR *pucBuffer;                           /*< Pointer to the buffer from where data will be read for transmission, or into which received data will be placed. */\r
  50 } xI2CMessage;\r
  51 \r
  52 /* Constants to use as the ulDirection parameter of i2cMessage(). */\r
  53 #define i2cWRITE                                ( ( unsigned portLONG ) 0 )\r
  54 #define i2cREAD                                 ( ( unsigned portLONG ) 1 )\r
  55 \r
  56 /**\r
  57  * Must be called once before any calls to i2cMessage.\r
  58  */\r
  59 void i2cInit( void );\r
  60 \r
  61 /**\r
  62  * Send or receive a message over the I2C bus.\r
  63  *\r
  64  * @param pucMessage     The data to be transmitted or the buffer into which\r
  65  *                                               received data will be placed. \r
  66  *\r
  67  * @param lMessageLength The number of bytes to either transmit or receive.\r
  68  *\r
  69  * @param ucSlaveAddress The slave address of the WIZNet device on the I2C bus.\r
  70  *\r
  71  * @param usBufferAddress The address within the WIZNet device to which data is\r
  72  *                                               either written to or read from.  The WIZnet has it's\r
  73  *                                               own Rx and Tx buffers.\r
  74  *\r
  75  * @param ulDirection    Must be either i2cWRITE or i2cREAD as #defined above.\r
  76  *\r
  77  * @param xMessageCompleteSemaphore\r
  78  *                                               Can be used to pass a semaphore reference if the \r
  79  *                                               calling task want notification of when the message has\r
  80  *                                               completed.  Otherwise NULL can be passed.\r
  81  * \r
  82  * @param xBlockTime     The time to wait for a space in the message queue to \r
  83  *                                               become available should one not be available \r
  84  *                                               immediately.\r
  85  */\r
  86 void i2cMessage( const unsigned portCHAR * const pucMessage, portLONG lMessageLength, unsigned portCHAR ucSlaveAddress, unsigned portSHORT usBufferAddress, unsigned portLONG ulDirection, xSemaphoreHandle xMessageCompleteSemaphore, portTickType xBlockTime );\r
  87 \r
  88 #endif\r
  89 \r