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

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