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

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