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

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