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

   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 \r
  54 /* Standard includes. */\r
  55 #include <stdlib.h>\r
  56 \r
  57 /* Scheduler include files. */\r
  58 #include "FreeRTOS.h"\r
  59 #include "queue.h"\r
  60 #include "semphr.h"\r
  61 \r
  62 /* Application includes. */\r
  63 #include "i2c.h"\r
  64 \r
  65 /*-----------------------------------------------------------*/\r
  66 \r
  67 /* Constants to setup the microcontroller IO. */\r
  68 #define mainSDA_ENABLE                  ( ( unsigned portLONG ) 0x0040 )\r
  69 #define mainSCL_ENABLE                  ( ( unsigned portLONG ) 0x0010 )\r
  70 \r
  71 /* Bit definitions within the I2CONCLR register. */\r
  72 #define i2cSTA_BIT                              ( ( unsigned portCHAR ) 0x20 )\r
  73 #define i2cSI_BIT                               ( ( unsigned portCHAR ) 0x08 )\r
  74 #define i2cSTO_BIT                              ( ( unsigned portCHAR ) 0x10 )\r
  75 \r
  76 /* Constants required to setup the VIC. */\r
  77 #define i2cI2C_VIC_CHANNEL              ( ( unsigned portLONG ) 0x0009 )\r
  78 #define i2cI2C_VIC_CHANNEL_BIT  ( ( unsigned portLONG ) 0x0200 )\r
  79 #define i2cI2C_VIC_ENABLE               ( ( unsigned portLONG ) 0x0020 )\r
  80 \r
  81 /* Misc constants. */\r
  82 #define i2cNO_BLOCK                             ( ( portTickType ) 0 )\r
  83 #define i2cQUEUE_LENGTH                 ( ( unsigned portCHAR ) 5 )\r
  84 #define i2cEXTRA_MESSAGES               ( ( unsigned portCHAR ) 2 )\r
  85 #define i2cREAD_TX_LEN                  ( ( unsigned portLONG ) 2 )\r
  86 #define i2cACTIVE_MASTER_MODE   ( ( unsigned portCHAR ) 0x40 )\r
  87 #define i2cTIMERL                               ( 200 )\r
  88 #define i2cTIMERH                               ( 200 )\r
  89 \r
  90 /* Array of message definitions.  See the header file for more information\r
  91 on the structure members.  There are two more places in the queue than as\r
  92 defined by i2cQUEUE_LENGTH.  This is to ensure that there is always a free\r
  93 message available - one can be in the process of being transmitted and one\r
  94 can be left free. */\r
  95 static xI2CMessage xTxMessages[ i2cQUEUE_LENGTH + i2cEXTRA_MESSAGES ];\r
  96 \r
  97 /* Function in the ARM part of the code used to create the queues. */\r
  98 extern void vI2CISRCreateQueues( unsigned portBASE_TYPE uxQueueLength, xQueueHandle *pxTxMessages, unsigned portLONG **ppulBusFree );\r
  99 \r
 100 /* Index to the next free message in the xTxMessages array. */\r
 101 unsigned portLONG ulNextFreeMessage = ( unsigned portLONG ) 0;\r
 102 \r
 103 /* Queue of messages that are waiting transmission. */\r
 104 static xQueueHandle xMessagesForTx;\r
 105 \r
 106 /* Flag to indicate the state of the I2C ISR state machine. */\r
 107 static unsigned portLONG *pulBusFree;\r
 108 \r
 109 /*-----------------------------------------------------------*/\r
 110 void i2cMessage( const unsigned portCHAR * const pucMessage, portLONG lMessageLength, unsigned portCHAR ucSlaveAddress, unsigned portSHORT usBufferAddress, unsigned portLONG ulDirection, xSemaphoreHandle xMessageCompleteSemaphore, portTickType xBlockTime )\r
 111 {\r
 112 extern volatile xI2CMessage *pxCurrentMessage;\r
 113 xI2CMessage *pxNextFreeMessage;\r
 114 signed portBASE_TYPE xReturn;\r
 115 \r
 116         portENTER_CRITICAL();\r
 117         {\r
 118                 /* This message is guaranteed to be free as there are two more messages\r
 119                 than spaces in the queue allowing for one message to be in process of\r
 120                 being transmitted and one to be left free. */\r
 121                 pxNextFreeMessage = &( xTxMessages[ ulNextFreeMessage ] );\r
 122 \r
 123                 /* Fill the message with the data to be sent. */\r
 124 \r
 125                 /* Pointer to the actual data.  Only a pointer is stored (i.e. the \r
 126                 actual data is not copied, so the data being pointed to must still\r
 127                 be valid when the message eventually gets sent (it may be queued for\r
 128                 a while. */\r
 129                 pxNextFreeMessage->pucBuffer = ( unsigned portCHAR * ) pucMessage;              \r
 130 \r
 131                 /* This is the address of the I2C device we are going to transmit this\r
 132                 message to. */\r
 133                 pxNextFreeMessage->ucSlaveAddress = ucSlaveAddress | ( unsigned portCHAR ) ulDirection;\r
 134 \r
 135                 /* A semaphore can be used to allow the I2C ISR to indicate that the\r
 136                 message has been sent.  This can be NULL if you don't want to wait for\r
 137                 the message transmission to complete. */\r
 138                 pxNextFreeMessage->xMessageCompleteSemaphore = xMessageCompleteSemaphore;\r
 139 \r
 140                 /* How many bytes are to be sent? */\r
 141                 pxNextFreeMessage->lMessageLength = lMessageLength;\r
 142 \r
 143                 /* The address within the WIZnet device to which the data will be \r
 144                 written.  This could be the address of a register, or alternatively\r
 145                 a location within the WIZnet Tx buffer. */\r
 146                 pxNextFreeMessage->ucBufferAddressLowByte = ( unsigned portCHAR ) ( usBufferAddress & 0xff );\r
 147 \r
 148                 /* Second byte of the address. */\r
 149                 usBufferAddress >>= 8;\r
 150                 pxNextFreeMessage->ucBufferAddressHighByte = ( unsigned portCHAR ) ( usBufferAddress & 0xff );\r
 151 \r
 152                 /* Increment to the next message in the array - with a wrap around check. */\r
 153                 ulNextFreeMessage++;\r
 154                 if( ulNextFreeMessage >= ( i2cQUEUE_LENGTH + i2cEXTRA_MESSAGES ) )\r
 155                 {\r
 156                         ulNextFreeMessage = ( unsigned portLONG ) 0;\r
 157                 }\r
 158 \r
 159                 /* Is the I2C interrupt in the middle of transmitting a message? */\r
 160                 if( *pulBusFree == ( unsigned portLONG ) pdTRUE )\r
 161                 {\r
 162                         /* No message is currently being sent or queued to be sent.  We\r
 163                         can start the ISR sending this message immediately. */\r
 164                         pxCurrentMessage = pxNextFreeMessage;\r
 165 \r
 166                         I2C_I2CONCLR = i2cSI_BIT;       \r
 167                         I2C_I2CONSET = i2cSTA_BIT;\r
 168                         \r
 169                         *pulBusFree = ( unsigned portLONG ) pdFALSE;\r
 170                 }\r
 171                 else\r
 172                 {\r
 173                         /* The I2C interrupt routine is mid sending a message.  Queue\r
 174                         this message ready to be sent. */\r
 175                         xReturn = xQueueSend( xMessagesForTx, &pxNextFreeMessage, xBlockTime );\r
 176 \r
 177                         /* We may have blocked while trying to queue the message.  If this\r
 178                         was the case then the interrupt would have been enabled and we may\r
 179                         now find that the I2C interrupt routine is no longer sending a\r
 180                         message. */\r
 181                         if( ( *pulBusFree == ( unsigned portLONG ) pdTRUE ) && ( xReturn == pdPASS ) )\r
 182                         {\r
 183                                 /* Get the next message in the queue (this should be the \r
 184                                 message we just posted) and start off the transmission\r
 185                                 again. */\r
 186                                 xQueueReceive( xMessagesForTx, &pxNextFreeMessage, i2cNO_BLOCK );\r
 187                                 pxCurrentMessage = pxNextFreeMessage;\r
 188 \r
 189                                 I2C_I2CONCLR = i2cSI_BIT;       \r
 190                                 I2C_I2CONSET = i2cSTA_BIT;\r
 191                                 \r
 192                                 *pulBusFree = ( unsigned portLONG ) pdFALSE;\r
 193                         }\r
 194                 }\r
 195         }\r
 196         portEXIT_CRITICAL();\r
 197 }\r
 198 /*-----------------------------------------------------------*/\r
 199 \r
 200 void i2cInit( void )\r
 201 {\r
 202 extern void ( vI2C_ISR_Wrapper )( void );\r
 203 \r
 204         /* Create the queue used to send messages to the ISR. */\r
 205         vI2CISRCreateQueues( i2cQUEUE_LENGTH, &xMessagesForTx, &pulBusFree );\r
 206 \r
 207         /* Configure the I2C hardware. */\r
 208 \r
 209         I2C_I2CONCLR = 0xff; \r
 210 \r
 211         PCB_PINSEL0 |= mainSDA_ENABLE;\r
 212         PCB_PINSEL0 |= mainSCL_ENABLE;\r
 213 \r
 214         I2C_I2SCLL = i2cTIMERL;\r
 215         I2C_I2SCLH = i2cTIMERH;\r
 216         I2C_I2CONSET = i2cACTIVE_MASTER_MODE;\r
 217 \r
 218         portENTER_CRITICAL();\r
 219         {\r
 220                 /* Setup the VIC for the i2c interrupt. */\r
 221                 VICIntSelect &= ~( i2cI2C_VIC_CHANNEL_BIT );\r
 222                 VICIntEnable |= i2cI2C_VIC_CHANNEL_BIT;\r
 223                 VICVectAddr2 = ( portLONG ) vI2C_ISR_Wrapper;\r
 224 \r
 225                 VICVectCntl2 = i2cI2C_VIC_CHANNEL | i2cI2C_VIC_ENABLE;\r
 226         }\r
 227         portEXIT_CRITICAL();\r
 228 }\r
 229 \r