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

   1 /*\r
   2         FreeRTOS V5.4.1 - Copyright (C) 2009 Real Time Engineers Ltd.\r
   3 \r
   4         This file is part of the FreeRTOS distribution.\r
   5 \r
   6         FreeRTOS is free software; you can redistribute it and/or modify it     under \r
   7         the terms of the GNU General Public License (version 2) as published by the \r
   8         Free Software Foundation and modified by the FreeRTOS exception.\r
   9         **NOTE** The exception to the GPL is included to allow you to distribute a\r
  10         combined work that includes FreeRTOS without being obliged to provide the \r
  11         source code for proprietary components outside of the FreeRTOS kernel.  \r
  12         Alternative commercial license and support terms are also available upon \r
  13         request.  See the licensing section of http://www.FreeRTOS.org for full \r
  14         license details.\r
  15 \r
  16         FreeRTOS is distributed in the hope that it will be useful,     but WITHOUT\r
  17         ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\r
  18         FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for\r
  19         more details.\r
  20 \r
  21         You should have received a copy of the GNU General Public License along\r
  22         with FreeRTOS; if not, write to the Free Software Foundation, Inc., 59\r
  23         Temple Place, Suite 330, Boston, MA  02111-1307  USA.\r
  24 \r
  25 \r
  26         ***************************************************************************\r
  27         *                                                                         *\r
  28         * Looking for a quick start?  Then check out the FreeRTOS eBook!          *\r
  29         * See http://www.FreeRTOS.org/Documentation for details                   *\r
  30         *                                                                         *\r
  31         ***************************************************************************\r
  32 \r
  33         1 tab == 4 spaces!\r
  34 \r
  35         Please ensure to read the configuration and relevant port sections of the\r
  36         online documentation.\r
  37 \r
  38         http://www.FreeRTOS.org - Documentation, latest information, license and\r
  39         contact details.\r
  40 \r
  41         http://www.SafeRTOS.com - A version that is certified for use in safety\r
  42         critical systems.\r
  43 \r
  44         http://www.OpenRTOS.com - Commercial support, development, porting,\r
  45         licensing and training services.\r
  46 */\r
  47 \r
  48 \r
  49 /* Standard includes. */\r
  50 #include <stdlib.h>\r
  51 \r
  52 /* Scheduler include files. */\r
  53 #include "FreeRTOS.h"\r
  54 #include "queue.h"\r
  55 #include "semphr.h"\r
  56 \r
  57 /* Application includes. */\r
  58 #include "i2c.h"\r
  59 \r
  60 /*-----------------------------------------------------------*/\r
  61 \r
  62 /* Constants to setup the microcontroller IO. */\r
  63 #define mainSDA_ENABLE                  ( ( unsigned portLONG ) 0x0040 )\r
  64 #define mainSCL_ENABLE                  ( ( unsigned portLONG ) 0x0010 )\r
  65 \r
  66 /* Bit definitions within the I2CONCLR register. */\r
  67 #define i2cSTA_BIT                              ( ( unsigned portCHAR ) 0x20 )\r
  68 #define i2cSI_BIT                               ( ( unsigned portCHAR ) 0x08 )\r
  69 #define i2cSTO_BIT                              ( ( unsigned portCHAR ) 0x10 )\r
  70 \r
  71 /* Constants required to setup the VIC. */\r
  72 #define i2cI2C_VIC_CHANNEL              ( ( unsigned portLONG ) 0x0009 )\r
  73 #define i2cI2C_VIC_CHANNEL_BIT  ( ( unsigned portLONG ) 0x0200 )\r
  74 #define i2cI2C_VIC_ENABLE               ( ( unsigned portLONG ) 0x0020 )\r
  75 \r
  76 /* Misc constants. */\r
  77 #define i2cNO_BLOCK                             ( ( portTickType ) 0 )\r
  78 #define i2cQUEUE_LENGTH                 ( ( unsigned portCHAR ) 5 )\r
  79 #define i2cEXTRA_MESSAGES               ( ( unsigned portCHAR ) 2 )\r
  80 #define i2cREAD_TX_LEN                  ( ( unsigned portLONG ) 2 )\r
  81 #define i2cACTIVE_MASTER_MODE   ( ( unsigned portCHAR ) 0x40 )\r
  82 #define i2cTIMERL                               ( 200 )\r
  83 #define i2cTIMERH                               ( 200 )\r
  84 \r
  85 /* Array of message definitions.  See the header file for more information\r
  86 on the structure members.  There are two more places in the queue than as\r
  87 defined by i2cQUEUE_LENGTH.  This is to ensure that there is always a free\r
  88 message available - one can be in the process of being transmitted and one\r
  89 can be left free. */\r
  90 static xI2CMessage xTxMessages[ i2cQUEUE_LENGTH + i2cEXTRA_MESSAGES ];\r
  91 \r
  92 /* Function in the ARM part of the code used to create the queues. */\r
  93 extern void vI2CISRCreateQueues( unsigned portBASE_TYPE uxQueueLength, xQueueHandle *pxTxMessages, unsigned portLONG **ppulBusFree );\r
  94 \r
  95 /* Index to the next free message in the xTxMessages array. */\r
  96 unsigned portLONG ulNextFreeMessage = ( unsigned portLONG ) 0;\r
  97 \r
  98 /* Queue of messages that are waiting transmission. */\r
  99 static xQueueHandle xMessagesForTx;\r
 100 \r
 101 /* Flag to indicate the state of the I2C ISR state machine. */\r
 102 static unsigned portLONG *pulBusFree;\r
 103 \r
 104 /*-----------------------------------------------------------*/\r
 105 void i2cMessage( const unsigned portCHAR * const pucMessage, portLONG lMessageLength, unsigned portCHAR ucSlaveAddress, unsigned portSHORT usBufferAddress, unsigned portLONG ulDirection, xSemaphoreHandle xMessageCompleteSemaphore, portTickType xBlockTime )\r
 106 {\r
 107 extern volatile xI2CMessage *pxCurrentMessage;\r
 108 xI2CMessage *pxNextFreeMessage;\r
 109 signed portBASE_TYPE xReturn;\r
 110 \r
 111         portENTER_CRITICAL();\r
 112         {\r
 113                 /* This message is guaranteed to be free as there are two more messages\r
 114                 than spaces in the queue allowing for one message to be in process of\r
 115                 being transmitted and one to be left free. */\r
 116                 pxNextFreeMessage = &( xTxMessages[ ulNextFreeMessage ] );\r
 117 \r
 118                 /* Fill the message with the data to be sent. */\r
 119 \r
 120                 /* Pointer to the actual data.  Only a pointer is stored (i.e. the \r
 121                 actual data is not copied, so the data being pointed to must still\r
 122                 be valid when the message eventually gets sent (it may be queued for\r
 123                 a while. */\r
 124                 pxNextFreeMessage->pucBuffer = ( unsigned portCHAR * ) pucMessage;              \r
 125 \r
 126                 /* This is the address of the I2C device we are going to transmit this\r
 127                 message to. */\r
 128                 pxNextFreeMessage->ucSlaveAddress = ucSlaveAddress | ( unsigned portCHAR ) ulDirection;\r
 129 \r
 130                 /* A semaphore can be used to allow the I2C ISR to indicate that the\r
 131                 message has been sent.  This can be NULL if you don't want to wait for\r
 132                 the message transmission to complete. */\r
 133                 pxNextFreeMessage->xMessageCompleteSemaphore = xMessageCompleteSemaphore;\r
 134 \r
 135                 /* How many bytes are to be sent? */\r
 136                 pxNextFreeMessage->lMessageLength = lMessageLength;\r
 137 \r
 138                 /* The address within the WIZnet device to which the data will be \r
 139                 written.  This could be the address of a register, or alternatively\r
 140                 a location within the WIZnet Tx buffer. */\r
 141                 pxNextFreeMessage->ucBufferAddressLowByte = ( unsigned portCHAR ) ( usBufferAddress & 0xff );\r
 142 \r
 143                 /* Second byte of the address. */\r
 144                 usBufferAddress >>= 8;\r
 145                 pxNextFreeMessage->ucBufferAddressHighByte = ( unsigned portCHAR ) ( usBufferAddress & 0xff );\r
 146 \r
 147                 /* Increment to the next message in the array - with a wrap around check. */\r
 148                 ulNextFreeMessage++;\r
 149                 if( ulNextFreeMessage >= ( i2cQUEUE_LENGTH + i2cEXTRA_MESSAGES ) )\r
 150                 {\r
 151                         ulNextFreeMessage = ( unsigned portLONG ) 0;\r
 152                 }\r
 153 \r
 154                 /* Is the I2C interrupt in the middle of transmitting a message? */\r
 155                 if( *pulBusFree == ( unsigned portLONG ) pdTRUE )\r
 156                 {\r
 157                         /* No message is currently being sent or queued to be sent.  We\r
 158                         can start the ISR sending this message immediately. */\r
 159                         pxCurrentMessage = pxNextFreeMessage;\r
 160 \r
 161                         I2C_I2CONCLR = i2cSI_BIT;       \r
 162                         I2C_I2CONSET = i2cSTA_BIT;\r
 163                         \r
 164                         *pulBusFree = ( unsigned portLONG ) pdFALSE;\r
 165                 }\r
 166                 else\r
 167                 {\r
 168                         /* The I2C interrupt routine is mid sending a message.  Queue\r
 169                         this message ready to be sent. */\r
 170                         xReturn = xQueueSend( xMessagesForTx, &pxNextFreeMessage, xBlockTime );\r
 171 \r
 172                         /* We may have blocked while trying to queue the message.  If this\r
 173                         was the case then the interrupt would have been enabled and we may\r
 174                         now find that the I2C interrupt routine is no longer sending a\r
 175                         message. */\r
 176                         if( ( *pulBusFree == ( unsigned portLONG ) pdTRUE ) && ( xReturn == pdPASS ) )\r
 177                         {\r
 178                                 /* Get the next message in the queue (this should be the \r
 179                                 message we just posted) and start off the transmission\r
 180                                 again. */\r
 181                                 xQueueReceive( xMessagesForTx, &pxNextFreeMessage, i2cNO_BLOCK );\r
 182                                 pxCurrentMessage = pxNextFreeMessage;\r
 183 \r
 184                                 I2C_I2CONCLR = i2cSI_BIT;       \r
 185                                 I2C_I2CONSET = i2cSTA_BIT;\r
 186                                 \r
 187                                 *pulBusFree = ( unsigned portLONG ) pdFALSE;\r
 188                         }\r
 189                 }\r
 190         }\r
 191         portEXIT_CRITICAL();\r
 192 }\r
 193 /*-----------------------------------------------------------*/\r
 194 \r
 195 void i2cInit( void )\r
 196 {\r
 197 extern void ( vI2C_ISR_Wrapper )( void );\r
 198 \r
 199         /* Create the queue used to send messages to the ISR. */\r
 200         vI2CISRCreateQueues( i2cQUEUE_LENGTH, &xMessagesForTx, &pulBusFree );\r
 201 \r
 202         /* Configure the I2C hardware. */\r
 203 \r
 204         I2C_I2CONCLR = 0xff; \r
 205 \r
 206         PCB_PINSEL0 |= mainSDA_ENABLE;\r
 207         PCB_PINSEL0 |= mainSCL_ENABLE;\r
 208 \r
 209         I2C_I2SCLL = i2cTIMERL;\r
 210         I2C_I2SCLH = i2cTIMERH;\r
 211         I2C_I2CONSET = i2cACTIVE_MASTER_MODE;\r
 212 \r
 213         portENTER_CRITICAL();\r
 214         {\r
 215                 /* Setup the VIC for the i2c interrupt. */\r
 216                 VICIntSelect &= ~( i2cI2C_VIC_CHANNEL_BIT );\r
 217                 VICIntEnable |= i2cI2C_VIC_CHANNEL_BIT;\r
 218                 VICVectAddr2 = ( portLONG ) vI2C_ISR_Wrapper;\r
 219 \r
 220                 VICVectCntl2 = i2cI2C_VIC_CHANNEL | i2cI2C_VIC_ENABLE;\r
 221         }\r
 222         portEXIT_CRITICAL();\r
 223 }\r
 224 \r