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

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