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

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