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

   1 /*\r
   2     FreeRTOS V7.4.2 - Copyright (C) 2013 Real Time Engineers Ltd.\r
   3 \r
   4     FEATURES AND PORTS ARE ADDED TO FREERTOS ALL THE TIME.  PLEASE VISIT\r
   5     http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
   6 \r
   7     ***************************************************************************\r
   8      *                                                                       *\r
   9      *    FreeRTOS tutorial books are available in pdf and paperback.        *\r
  10      *    Complete, revised, and edited pdf reference manuals are also       *\r
  11      *    available.                                                         *\r
  12      *                                                                       *\r
  13      *    Purchasing FreeRTOS documentation will not only help you, by       *\r
  14      *    ensuring you get running as quickly as possible and with an        *\r
  15      *    in-depth knowledge of how to use FreeRTOS, it will also help       *\r
  16      *    the FreeRTOS project to continue with its mission of providing     *\r
  17      *    professional grade, cross platform, de facto standard solutions    *\r
  18      *    for microcontrollers - completely free of charge!                  *\r
  19      *                                                                       *\r
  20      *    >>> See http://www.FreeRTOS.org/Documentation for details. <<<     *\r
  21      *                                                                       *\r
  22      *    Thank you for using FreeRTOS, and thank you for your support!      *\r
  23      *                                                                       *\r
  24     ***************************************************************************\r
  25 \r
  26 \r
  27     This file is part of the FreeRTOS distribution.\r
  28 \r
  29     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  30     the terms of the GNU General Public License (version 2) as published by the\r
  31     Free Software Foundation AND MODIFIED BY the FreeRTOS exception.\r
  32 \r
  33     >>>>>>NOTE<<<<<< The modification to the GPL is included to allow you to\r
  34     distribute a combined work that includes FreeRTOS without being obliged to\r
  35     provide the source code for proprietary components outside of the FreeRTOS\r
  36     kernel.\r
  37 \r
  38     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  39     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  40     FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more\r
  41     details. You should have received a copy of the GNU General Public License\r
  42     and the FreeRTOS license exception along with FreeRTOS; if not it can be\r
  43     viewed here: http://www.freertos.org/a00114.html and also obtained by\r
  44     writing to Real Time Engineers Ltd., contact details for whom are available\r
  45     on the FreeRTOS WEB site.\r
  46 \r
  47     1 tab == 4 spaces!\r
  48 \r
  49     ***************************************************************************\r
  50      *                                                                       *\r
  51      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  52      *    not run, what could be wrong?"                                     *\r
  53      *                                                                       *\r
  54      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  55      *                                                                       *\r
  56     ***************************************************************************\r
  57 \r
  58 \r
  59     http://www.FreeRTOS.org - Documentation, books, training, latest versions, \r
  60     license and Real Time Engineers Ltd. contact details.\r
  61 \r
  62     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  63     including FreeRTOS+Trace - an indispensable productivity tool, and our new\r
  64     fully thread aware and reentrant UDP/IP stack.\r
  65 \r
  66     http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High \r
  67     Integrity Systems, who sell the code with commercial support, \r
  68     indemnification and middleware, under the OpenRTOS brand.\r
  69     \r
  70     http://www.SafeRTOS.com - High Integrity Systems also provide a safety \r
  71     engineered and independently SIL3 certified version for use in safety and \r
  72     mission critical applications that require provable dependability.\r
  73 */\r
  74 \r
  75 \r
  76 /* Standard includes. */\r
  77 #include <stdlib.h>\r
  78 \r
  79 /* Scheduler include files. */\r
  80 #include "FreeRTOS.h"\r
  81 #include "queue.h"\r
  82 #include "semphr.h"\r
  83 \r
  84 /* Application includes. */\r
  85 #include "i2c.h"\r
  86 \r
  87 /*-----------------------------------------------------------*/\r
  88 \r
  89 /* Constants to setup the microcontroller IO. */\r
  90 #define mainSDA_ENABLE                  ( ( unsigned long ) 0x0040 )\r
  91 #define mainSCL_ENABLE                  ( ( unsigned long ) 0x0010 )\r
  92 \r
  93 /* Bit definitions within the I2CONCLR register. */\r
  94 #define i2cSTA_BIT                              ( ( unsigned char ) 0x20 )\r
  95 #define i2cSI_BIT                               ( ( unsigned char ) 0x08 )\r
  96 #define i2cSTO_BIT                              ( ( unsigned char ) 0x10 )\r
  97 \r
  98 /* Constants required to setup the VIC. */\r
  99 #define i2cI2C_VIC_CHANNEL              ( ( unsigned long ) 0x0009 )\r
 100 #define i2cI2C_VIC_CHANNEL_BIT  ( ( unsigned long ) 0x0200 )\r
 101 #define i2cI2C_VIC_ENABLE               ( ( unsigned long ) 0x0020 )\r
 102 \r
 103 /* Misc constants. */\r
 104 #define i2cNO_BLOCK                             ( ( portTickType ) 0 )\r
 105 #define i2cQUEUE_LENGTH                 ( ( unsigned char ) 5 )\r
 106 #define i2cEXTRA_MESSAGES               ( ( unsigned char ) 2 )\r
 107 #define i2cREAD_TX_LEN                  ( ( unsigned long ) 2 )\r
 108 #define i2cACTIVE_MASTER_MODE   ( ( unsigned char ) 0x40 )\r
 109 #define i2cTIMERL                               ( 200 )\r
 110 #define i2cTIMERH                               ( 200 )\r
 111 \r
 112 /* Array of message definitions.  See the header file for more information\r
 113 on the structure members.  There are two more places in the queue than as\r
 114 defined by i2cQUEUE_LENGTH.  This is to ensure that there is always a free\r
 115 message available - one can be in the process of being transmitted and one\r
 116 can be left free. */\r
 117 static xI2CMessage xTxMessages[ i2cQUEUE_LENGTH + i2cEXTRA_MESSAGES ];\r
 118 \r
 119 /* Function in the ARM part of the code used to create the queues. */\r
 120 extern void vI2CISRCreateQueues( unsigned portBASE_TYPE uxQueueLength, xQueueHandle *pxTxMessages, unsigned long **ppulBusFree );\r
 121 \r
 122 /* Index to the next free message in the xTxMessages array. */\r
 123 unsigned long ulNextFreeMessage = ( unsigned long ) 0;\r
 124 \r
 125 /* Queue of messages that are waiting transmission. */\r
 126 static xQueueHandle xMessagesForTx;\r
 127 \r
 128 /* Flag to indicate the state of the I2C ISR state machine. */\r
 129 static unsigned long *pulBusFree;\r
 130 \r
 131 /*-----------------------------------------------------------*/\r
 132 void i2cMessage( const unsigned char * const pucMessage, long lMessageLength, unsigned char ucSlaveAddress, unsigned short usBufferAddress, unsigned long ulDirection, xSemaphoreHandle xMessageCompleteSemaphore, portTickType xBlockTime )\r
 133 {\r
 134 extern volatile xI2CMessage *pxCurrentMessage;\r
 135 xI2CMessage *pxNextFreeMessage;\r
 136 signed portBASE_TYPE xReturn;\r
 137 \r
 138         portENTER_CRITICAL();\r
 139         {\r
 140                 /* This message is guaranteed to be free as there are two more messages\r
 141                 than spaces in the queue allowing for one message to be in process of\r
 142                 being transmitted and one to be left free. */\r
 143                 pxNextFreeMessage = &( xTxMessages[ ulNextFreeMessage ] );\r
 144 \r
 145                 /* Fill the message with the data to be sent. */\r
 146 \r
 147                 /* Pointer to the actual data.  Only a pointer is stored (i.e. the \r
 148                 actual data is not copied, so the data being pointed to must still\r
 149                 be valid when the message eventually gets sent (it may be queued for\r
 150                 a while. */\r
 151                 pxNextFreeMessage->pucBuffer = ( unsigned char * ) pucMessage;          \r
 152 \r
 153                 /* This is the address of the I2C device we are going to transmit this\r
 154                 message to. */\r
 155                 pxNextFreeMessage->ucSlaveAddress = ucSlaveAddress | ( unsigned char ) ulDirection;\r
 156 \r
 157                 /* A semaphore can be used to allow the I2C ISR to indicate that the\r
 158                 message has been sent.  This can be NULL if you don't want to wait for\r
 159                 the message transmission to complete. */\r
 160                 pxNextFreeMessage->xMessageCompleteSemaphore = xMessageCompleteSemaphore;\r
 161 \r
 162                 /* How many bytes are to be sent? */\r
 163                 pxNextFreeMessage->lMessageLength = lMessageLength;\r
 164 \r
 165                 /* The address within the WIZnet device to which the data will be \r
 166                 written.  This could be the address of a register, or alternatively\r
 167                 a location within the WIZnet Tx buffer. */\r
 168                 pxNextFreeMessage->ucBufferAddressLowByte = ( unsigned char ) ( usBufferAddress & 0xff );\r
 169 \r
 170                 /* Second byte of the address. */\r
 171                 usBufferAddress >>= 8;\r
 172                 pxNextFreeMessage->ucBufferAddressHighByte = ( unsigned char ) ( usBufferAddress & 0xff );\r
 173 \r
 174                 /* Increment to the next message in the array - with a wrap around check. */\r
 175                 ulNextFreeMessage++;\r
 176                 if( ulNextFreeMessage >= ( i2cQUEUE_LENGTH + i2cEXTRA_MESSAGES ) )\r
 177                 {\r
 178                         ulNextFreeMessage = ( unsigned long ) 0;\r
 179                 }\r
 180 \r
 181                 /* Is the I2C interrupt in the middle of transmitting a message? */\r
 182                 if( *pulBusFree == ( unsigned long ) pdTRUE )\r
 183                 {\r
 184                         /* No message is currently being sent or queued to be sent.  We\r
 185                         can start the ISR sending this message immediately. */\r
 186                         pxCurrentMessage = pxNextFreeMessage;\r
 187 \r
 188                         I2C_I2CONCLR = i2cSI_BIT;       \r
 189                         I2C_I2CONSET = i2cSTA_BIT;\r
 190                         \r
 191                         *pulBusFree = ( unsigned long ) pdFALSE;\r
 192                 }\r
 193                 else\r
 194                 {\r
 195                         /* The I2C interrupt routine is mid sending a message.  Queue\r
 196                         this message ready to be sent. */\r
 197                         xReturn = xQueueSend( xMessagesForTx, &pxNextFreeMessage, xBlockTime );\r
 198 \r
 199                         /* We may have blocked while trying to queue the message.  If this\r
 200                         was the case then the interrupt would have been enabled and we may\r
 201                         now find that the I2C interrupt routine is no longer sending a\r
 202                         message. */\r
 203                         if( ( *pulBusFree == ( unsigned long ) pdTRUE ) && ( xReturn == pdPASS ) )\r
 204                         {\r
 205                                 /* Get the next message in the queue (this should be the \r
 206                                 message we just posted) and start off the transmission\r
 207                                 again. */\r
 208                                 xQueueReceive( xMessagesForTx, &pxNextFreeMessage, i2cNO_BLOCK );\r
 209                                 pxCurrentMessage = pxNextFreeMessage;\r
 210 \r
 211                                 I2C_I2CONCLR = i2cSI_BIT;       \r
 212                                 I2C_I2CONSET = i2cSTA_BIT;\r
 213                                 \r
 214                                 *pulBusFree = ( unsigned long ) pdFALSE;\r
 215                         }\r
 216                 }\r
 217         }\r
 218         portEXIT_CRITICAL();\r
 219 }\r
 220 /*-----------------------------------------------------------*/\r
 221 \r
 222 void i2cInit( void )\r
 223 {\r
 224 extern void ( vI2C_ISR_Wrapper )( void );\r
 225 \r
 226         /* Create the queue used to send messages to the ISR. */\r
 227         vI2CISRCreateQueues( i2cQUEUE_LENGTH, &xMessagesForTx, &pulBusFree );\r
 228 \r
 229         /* Configure the I2C hardware. */\r
 230 \r
 231         I2C_I2CONCLR = 0xff; \r
 232 \r
 233         PCB_PINSEL0 |= mainSDA_ENABLE;\r
 234         PCB_PINSEL0 |= mainSCL_ENABLE;\r
 235 \r
 236         I2C_I2SCLL = i2cTIMERL;\r
 237         I2C_I2SCLH = i2cTIMERH;\r
 238         I2C_I2CONSET = i2cACTIVE_MASTER_MODE;\r
 239 \r
 240         portENTER_CRITICAL();\r
 241         {\r
 242                 /* Setup the VIC for the i2c interrupt. */\r
 243                 VICIntSelect &= ~( i2cI2C_VIC_CHANNEL_BIT );\r
 244                 VICIntEnable |= i2cI2C_VIC_CHANNEL_BIT;\r
 245                 VICVectAddr2 = ( long ) vI2C_ISR_Wrapper;\r
 246 \r
 247                 VICVectCntl2 = i2cI2C_VIC_CHANNEL | i2cI2C_VIC_ENABLE;\r
 248         }\r
 249         portEXIT_CRITICAL();\r
 250 }\r
 251 \r