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

   1 /*\r
   2         FreeRTOS.org V5.1.2 - Copyright (C) 2003-2009 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     ***************************************************************************\r
  28     *                                                                         *\r
  29     * Get the FreeRTOS eBook!  See http://www.FreeRTOS.org/Documentation      *\r
  30         *                                                                         *\r
  31         * This is a concise, step by step, 'hands on' guide that describes both   *\r
  32         * general multitasking concepts and FreeRTOS specifics. It presents and   *\r
  33         * explains numerous examples that are written using the FreeRTOS API.     *\r
  34         * Full source code for all the examples is provided in an accompanying    *\r
  35         * .zip file.                                                              *\r
  36     *                                                                         *\r
  37     ***************************************************************************\r
  38     ***************************************************************************\r
  39 \r
  40         Please ensure to read the configuration and relevant port sections of the\r
  41         online documentation.\r
  42 \r
  43         http://www.FreeRTOS.org - Documentation, latest information, license and \r
  44         contact details.\r
  45 \r
  46         http://www.SafeRTOS.com - A version that is certified for use in safety \r
  47         critical systems.\r
  48 \r
  49         http://www.OpenRTOS.com - Commercial support, development, porting, \r
  50         licensing and training services.\r
  51 */\r
  52 \r
  53 #ifndef I2C_H\r
  54 #define I2C_H\r
  55 \r
  56 /* Structure used to capture the I2C message details.  The structure is then\r
  57  * queued for processing by the I2C ISR. \r
  58  */\r
  59 typedef struct AN_I2C_MESSAGE\r
  60 {\r
  61         portLONG lMessageLength;                                        /*< How many bytes of data to send or received - excluding the buffer address. */\r
  62         unsigned portCHAR ucSlaveAddress;                       /*< The slave address of the WIZnet on the I2C bus. */\r
  63         unsigned portCHAR ucBufferAddressLowByte;       /*< The address within the WIZnet device to which data should be read from / written to. */\r
  64         unsigned portCHAR ucBufferAddressHighByte;      /*< As above, high byte. */\r
  65         xSemaphoreHandle xMessageCompleteSemaphore;     /*< Contains a reference to a semaphore if the application tasks wants notifying when the message has been transacted. */\r
  66         unsigned portCHAR *pucBuffer;                           /*< Pointer to the buffer from where data will be read for transmission, or into which received data will be placed. */\r
  67 } xI2CMessage;\r
  68 \r
  69 /* Constants to use as the ulDirection parameter of i2cMessage(). */\r
  70 #define i2cWRITE                                ( ( unsigned portLONG ) 0 )\r
  71 #define i2cREAD                                 ( ( unsigned portLONG ) 1 )\r
  72 \r
  73 /**\r
  74  * Must be called once before any calls to i2cMessage.\r
  75  */\r
  76 void i2cInit( void );\r
  77 \r
  78 /**\r
  79  * Send or receive a message over the I2C bus.\r
  80  *\r
  81  * @param pucMessage     The data to be transmitted or the buffer into which\r
  82  *                                               received data will be placed. \r
  83  *\r
  84  * @param lMessageLength The number of bytes to either transmit or receive.\r
  85  *\r
  86  * @param ucSlaveAddress The slave address of the WIZNet device on the I2C bus.\r
  87  *\r
  88  * @param usBufferAddress The address within the WIZNet device to which data is\r
  89  *                                               either written to or read from.  The WIZnet has it's\r
  90  *                                               own Rx and Tx buffers.\r
  91  *\r
  92  * @param ulDirection    Must be either i2cWRITE or i2cREAD as #defined above.\r
  93  *\r
  94  * @param xMessageCompleteSemaphore\r
  95  *                                               Can be used to pass a semaphore reference if the \r
  96  *                                               calling task want notification of when the message has\r
  97  *                                               completed.  Otherwise NULL can be passed.\r
  98  * \r
  99  * @param xBlockTime     The time to wait for a space in the message queue to \r
 100  *                                               become available should one not be available \r
 101  *                                               immediately.\r
 102  */\r
 103 void i2cMessage( const unsigned portCHAR * const pucMessage, portLONG lMessageLength, unsigned portCHAR ucSlaveAddress, unsigned portSHORT usBufferAddress, unsigned portLONG ulDirection, xSemaphoreHandle xMessageCompleteSemaphore, portTickType xBlockTime );\r
 104 \r
 105 #endif\r
 106 \r