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

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