git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/dsPIC_MPLAB/lcd.c

   1 /*\r
   2     FreeRTOS V7.4.1 - Copyright (C) 2013 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 \r
  33     >>>>>>NOTE<<<<<< The modification to the GPL is included to allow you to\r
  34     distribute a combined work that includes FreeRTOS without being obliged to\r
  35     provide the source code for proprietary components outside of the FreeRTOS\r
  36     kernel.\r
  37 \r
  38     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  39     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  40     FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more\r
  41     details. You should have received a copy of the GNU General Public License\r
  42     and the FreeRTOS license exception along with FreeRTOS; if not it can be\r
  43     viewed here: http://www.freertos.org/a00114.html and also obtained by\r
  44     writing to Real Time Engineers Ltd., contact details for whom are available\r
  45     on the FreeRTOS WEB site.\r
  46 \r
  47     1 tab == 4 spaces!\r
  48 \r
  49     ***************************************************************************\r
  50      *                                                                       *\r
  51      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  52      *    not run, what could be wrong?"                                     *\r
  53      *                                                                       *\r
  54      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  55      *                                                                       *\r
  56     ***************************************************************************\r
  57 \r
  58 \r
  59     http://www.FreeRTOS.org - Documentation, books, training, latest versions, \r
  60     license and Real Time Engineers Ltd. contact details.\r
  61 \r
  62     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  63     including FreeRTOS+Trace - an indispensable productivity tool, and our new\r
  64     fully thread aware and reentrant UDP/IP stack.\r
  65 \r
  66     http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High \r
  67     Integrity Systems, who sell the code with commercial support, \r
  68     indemnification and middleware, under the OpenRTOS brand.\r
  69     \r
  70     http://www.SafeRTOS.com - High Integrity Systems also provide a safety \r
  71     engineered and independently SIL3 certified version for use in safety and \r
  72     mission critical applications that require provable dependability.\r
  73 */\r
  74 \r
  75 /* Scheduler includes. */\r
  76 #include "FreeRTOS.h"\r
  77 #include "task.h"\r
  78 #include "queue.h"\r
  79 \r
  80 /* Demo includes. */\r
  81 #include "lcd.h"\r
  82 \r
  83 /*\r
  84  * The LCD is written to by more than one task so is controlled by this\r
  85  * 'gatekeeper' task.  This is the only task that is actually permitted to\r
  86  * access the LCD directly.  Other tasks wanting to display a message send\r
  87  * the message to the gatekeeper.\r
  88  */\r
  89 static void vLCDTask( void *pvParameters );\r
  90 \r
  91 /*\r
  92  * Setup the peripherals required to communicate with the LCD.\r
  93  */\r
  94 static void prvSetupLCD( void );\r
  95 \r
  96 /* \r
  97  * Move to the first (0) or second (1) row of the LCD. \r
  98  */\r
  99 static void prvLCDGotoRow( unsigned portSHORT usRow );\r
 100 \r
 101 /* \r
 102  * Write a string of text to the LCD. \r
 103  */\r
 104 static void prvLCDPutString( portCHAR *pcString );\r
 105 \r
 106 /* \r
 107  * Clear the LCD. \r
 108  */\r
 109 static void prvLCDClear( void );\r
 110 \r
 111 /*-----------------------------------------------------------*/\r
 112 \r
 113 /* Brief delay to permit the LCD to catch up with commands. */\r
 114 #define lcdVERY_SHORT_DELAY     ( 1 )\r
 115 #define lcdSHORT_DELAY          ( 4 / portTICK_RATE_MS )\r
 116 #define lcdLONG_DELAY           ( 15 / portTICK_RATE_MS )\r
 117 \r
 118 /* LCD commands. */\r
 119 #define lcdCLEAR                        ( 0x01 )\r
 120 #define lcdHOME                         ( 0x02 )\r
 121 #define lcdLINE2                        ( 0xc0 )\r
 122 \r
 123 /* SFR that seems to be missing from the standard header files. */\r
 124 #define PMAEN                           *( ( unsigned short * ) 0x60c )\r
 125 \r
 126 /* LCD R/W signal. */\r
 127 #define  lcdRW  LATDbits.LATD5       \r
 128 \r
 129 /* LCD lcdRS signal. */\r
 130 #define  lcdRS  LATBbits.LATB15      \r
 131 \r
 132 /* LCD lcdE signal . */\r
 133 #define  lcdE   LATDbits.LATD4       \r
 134 \r
 135 /* Control signal pin direction. */\r
 136 #define  RW_TRIS        TRISDbits.TRISD5 \r
 137 #define  RS_TRIS        TRISBbits.TRISB15\r
 138 #define  E_TRIS         TRISDbits.TRISD4\r
 139 \r
 140 /* Port for LCD data */\r
 141 #define  lcdDATA      LATE           \r
 142 #define  lcdDATAPORT  PORTE\r
 143 \r
 144 /* I/O setup for data Port. */\r
 145 #define  TRISDATA  TRISE          \r
 146 \r
 147 /* The length of the queue used to send messages to the LCD gatekeeper task. */\r
 148 #define lcdQUEUE_SIZE           3\r
 149 /*-----------------------------------------------------------*/\r
 150 \r
 151 /* The queue used to send messages to the LCD task. */\r
 152 xQueueHandle xLCDQueue;\r
 153 \r
 154 static void prvLCDCommand( portCHAR cCommand );\r
 155 static void prvLCDData( portCHAR cChar );\r
 156 \r
 157 /*-----------------------------------------------------------*/\r
 158 \r
 159 xQueueHandle xStartLCDTask( void )\r
 160 {\r
 161         /* Create the queue used by the LCD task.  Messages for display on the LCD\r
 162         are received via this queue. */\r
 163         xLCDQueue = xQueueCreate( lcdQUEUE_SIZE, sizeof( xLCDMessage ) );\r
 164 \r
 165         /* Start the task that will write to the LCD.  The LCD hardware is\r
 166         initialised from within the task itself so delays can be used. */\r
 167         xTaskCreate( vLCDTask, ( signed portCHAR * ) "LCD", configMINIMAL_STACK_SIZE, NULL, tskIDLE_PRIORITY + 1, NULL );\r
 168 \r
 169         return xLCDQueue;\r
 170 }\r
 171 /*-----------------------------------------------------------*/\r
 172 \r
 173 static void prvLCDGotoRow( unsigned portSHORT usRow )\r
 174 {\r
 175         if( usRow == 0 )\r
 176         {\r
 177                 prvLCDCommand( lcdHOME );\r
 178         }\r
 179         else\r
 180         {\r
 181                 prvLCDCommand( lcdLINE2 );\r
 182         }\r
 183 }\r
 184 /*-----------------------------------------------------------*/\r
 185 \r
 186 static void prvLCDCommand( portCHAR cCommand ) \r
 187 {\r
 188         /* Prepare RD0 - RD7. */\r
 189         lcdDATA &= 0xFF00;               \r
 190 \r
 191         /* Command byte to lcd. */\r
 192     lcdDATA |= cCommand;                  \r
 193 \r
 194         /* Ensure lcdRW is 0. */\r
 195         lcdRW = 0;                       \r
 196     lcdRS = 0;\r
 197 \r
 198         /* Toggle lcdE line. */\r
 199     lcdE = 1;                        \r
 200     vTaskDelay( lcdVERY_SHORT_DELAY );\r
 201     lcdE = 0;\r
 202 \r
 203         vTaskDelay( lcdSHORT_DELAY );\r
 204 }\r
 205 /*-----------------------------------------------------------*/\r
 206 \r
 207 static void prvLCDData( portCHAR cChar )\r
 208 {\r
 209         /* ensure lcdRW is 0. */\r
 210         lcdRW = 0;                                       \r
 211 \r
 212         /* Assert register select to 1. */\r
 213     lcdRS = 1;                       \r
 214 \r
 215         /* Prepare RD0 - RD7. */\r
 216         lcdDATA &= 0xFF00;               \r
 217 \r
 218         /* Data byte to lcd. */\r
 219     lcdDATA |= cChar;                 \r
 220     lcdE = 1;                           \r
 221         Nop();\r
 222     Nop();\r
 223     Nop();\r
 224 \r
 225         /* Toggle lcdE signal. */\r
 226     lcdE = 0;                       \r
 227 \r
 228         /* Negate register select to 0. */\r
 229     lcdRS = 0;                      \r
 230 \r
 231         vTaskDelay( lcdVERY_SHORT_DELAY );\r
 232 }\r
 233 /*-----------------------------------------------------------*/\r
 234 \r
 235 static void prvLCDPutString( portCHAR *pcString )\r
 236 {\r
 237         /* Write out each character with appropriate delay between each. */\r
 238         while( *pcString )\r
 239         {\r
 240                 prvLCDData( *pcString );\r
 241                 pcString++;\r
 242                 vTaskDelay( lcdSHORT_DELAY );\r
 243         }\r
 244 }\r
 245 /*-----------------------------------------------------------*/\r
 246 \r
 247 static void prvLCDClear( void )\r
 248 {\r
 249         prvLCDCommand( lcdCLEAR );\r
 250 }\r
 251 /*-----------------------------------------------------------*/\r
 252 \r
 253 static void prvSetupLCD( void )\r
 254 {\r
 255         /* Wait for proper power up. */\r
 256         vTaskDelay( lcdLONG_DELAY );\r
 257                         \r
 258         /* Set initial states for the data and control pins */\r
 259         LATE &= 0xFF00; \r
 260 \r
 261         /* R/W state set low. */\r
 262     lcdRW = 0;                       \r
 263 \r
 264         /* lcdRS state set low. */\r
 265         lcdRS = 0;                       \r
 266 \r
 267         /* lcdE state set low. */\r
 268         lcdE = 0;                        \r
 269 \r
 270         /* Set data and control pins to outputs */\r
 271         TRISE &= 0xFF00;\r
 272 \r
 273         /* lcdRW pin set as output. */\r
 274         RW_TRIS = 0;                  \r
 275 \r
 276         /* lcdRS pin set as output. */\r
 277         RS_TRIS = 0;                  \r
 278 \r
 279         /* lcdE pin set as output. */\r
 280         E_TRIS = 0;                   \r
 281 \r
 282         /* 1st LCD initialization sequence */\r
 283         lcdDATA &= 0xFF00;\r
 284     lcdDATA |= 0x0038;\r
 285     lcdE = 1;   \r
 286     Nop();\r
 287     Nop();\r
 288     Nop();\r
 289 \r
 290         /* Toggle lcdE signal. */\r
 291     lcdE = 0;                        \r
 292 \r
 293         vTaskDelay( lcdSHORT_DELAY );\r
 294         vTaskDelay( lcdSHORT_DELAY );\r
 295         vTaskDelay( lcdSHORT_DELAY );\r
 296       \r
 297         /* 2nd LCD initialization sequence */\r
 298         lcdDATA &= 0xFF00;\r
 299     lcdDATA |= 0x0038;\r
 300     lcdE = 1;   \r
 301     Nop();\r
 302     Nop();\r
 303     Nop();      \r
 304 \r
 305         /* Toggle lcdE signal. */\r
 306     lcdE = 0;                        \r
 307 \r
 308     vTaskDelay( lcdSHORT_DELAY );\r
 309 \r
 310         /* 3rd LCD initialization sequence */\r
 311         lcdDATA &= 0xFF00;\r
 312     lcdDATA |= 0x0038;\r
 313     lcdE = 1;           \r
 314     Nop();\r
 315     Nop();\r
 316     Nop();      \r
 317 \r
 318         /* Toggle lcdE signal. */\r
 319     lcdE = 0;                        \r
 320 \r
 321         vTaskDelay( lcdSHORT_DELAY );\r
 322 \r
 323 \r
 324         /* Function set. */\r
 325     prvLCDCommand( 0x38 );              \r
 326 \r
 327         /* Display on/off control, cursor blink off (0x0C). */\r
 328     prvLCDCommand( 0x0C );              \r
 329 \r
 330         /* Entry mode set (0x06). */\r
 331     prvLCDCommand( 0x06 );              \r
 332 \r
 333         prvLCDCommand( lcdCLEAR );        \r
 334 }\r
 335 /*-----------------------------------------------------------*/\r
 336 \r
 337 static void vLCDTask( void *pvParameters )\r
 338 {\r
 339 xLCDMessage xMessage;\r
 340 unsigned portSHORT usRow = 0;\r
 341 \r
 342         /* Initialise the hardware.  This uses delays so must not be called prior\r
 343         to the scheduler being started. */\r
 344         prvSetupLCD();\r
 345 \r
 346         /* Welcome message. */\r
 347         prvLCDPutString( "www.FreeRTOS.org" );\r
 348 \r
 349         for( ;; )\r
 350         {\r
 351                 /* Wait for a message to arrive that requires displaying. */\r
 352                 while( xQueueReceive( xLCDQueue, &xMessage, portMAX_DELAY ) != pdPASS );\r
 353 \r
 354                 /* Clear the current display value. */\r
 355                 prvLCDClear();\r
 356 \r
 357                 /* Switch rows each time so we can see that the display is still being\r
 358                 updated. */\r
 359                 prvLCDGotoRow( usRow & 0x01 );\r
 360                 usRow++;\r
 361                 prvLCDPutString( xMessage.pcMessage );\r
 362 \r
 363                 /* Delay the requested amount of time to ensure the text just written \r
 364                 to the LCD is not overwritten. */\r
 365                 vTaskDelay( xMessage.xMinDisplayTime );         \r
 366         }\r
 367 }\r
 368 \r
 369 \r
 370 \r
 371 \r