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

   1 /*\r
   2     FreeRTOS V7.4.0 - 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 itcan 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 lcdSHORT_DELAY          3\r
 115 \r
 116 /* SFR that seems to be missing from the standard header files. */\r
 117 #define PMAEN                           *( ( unsigned short * ) 0x60c )\r
 118 \r
 119 /* LCD commands. */\r
 120 #define lcdDEFAULT_FUNCTION     0x3c\r
 121 #define lcdDISPLAY_CONTROL      0x0c\r
 122 #define lcdCLEAR_DISPLAY        0x01\r
 123 #define lcdENTRY_MODE           0x06\r
 124 \r
 125 /* The length of the queue used to send messages to the LCD gatekeeper task. */\r
 126 #define lcdQUEUE_SIZE           3\r
 127 /*-----------------------------------------------------------*/\r
 128 \r
 129 /* The queue used to send messages to the LCD task. */\r
 130 xQueueHandle xLCDQueue;\r
 131 \r
 132 \r
 133 /*-----------------------------------------------------------*/\r
 134 \r
 135 xQueueHandle xStartLCDTask( void )\r
 136 {\r
 137         /* Create the queue used by the LCD task.  Messages for display on the LCD\r
 138         are received via this queue. */\r
 139         xLCDQueue = xQueueCreate( lcdQUEUE_SIZE, sizeof( xLCDMessage ) );\r
 140 \r
 141         /* Start the task that will write to the LCD.  The LCD hardware is\r
 142         initialised from within the task itself so delays can be used. */\r
 143         xTaskCreate( vLCDTask, ( signed portCHAR * ) "LCD", configMINIMAL_STACK_SIZE, NULL, tskIDLE_PRIORITY + 1, NULL );\r
 144 \r
 145         return xLCDQueue;\r
 146 }\r
 147 /*-----------------------------------------------------------*/\r
 148 \r
 149 static void prvLCDGotoRow( unsigned portSHORT usRow )\r
 150 {\r
 151         if( usRow == 0 )\r
 152         {\r
 153                 PMADDR = 0x0000;\r
 154                 PMDIN1 = 0x02;\r
 155         }\r
 156         else\r
 157         {\r
 158                 PMADDR = 0x0000;\r
 159                 PMDIN1 = 0xc0;\r
 160         }\r
 161 \r
 162         vTaskDelay( lcdSHORT_DELAY );\r
 163 }\r
 164 /*-----------------------------------------------------------*/\r
 165 \r
 166 static void prvLCDPutString( portCHAR *pcString )\r
 167 {\r
 168         /* Write out each character with appropriate delay between each. */\r
 169         while( *pcString )\r
 170         {\r
 171                 PMADDR = 0x0001;\r
 172                 PMDIN1 = *pcString;\r
 173                 pcString++;\r
 174                 vTaskDelay( lcdSHORT_DELAY );\r
 175         }\r
 176 }\r
 177 /*-----------------------------------------------------------*/\r
 178 \r
 179 static void prvLCDClear( void )\r
 180 {\r
 181         /* Clear the display. */\r
 182         PMADDR = 0x0000;\r
 183         PMDIN1 = lcdCLEAR_DISPLAY;\r
 184         vTaskDelay( lcdSHORT_DELAY );   \r
 185 }\r
 186 /*-----------------------------------------------------------*/\r
 187 \r
 188 static void prvSetupLCD( void )\r
 189 {\r
 190         /* Setup the PMP. */\r
 191         PMCON = 0x83BF;\r
 192         PMMODE = 0x3FF;\r
 193         PMAEN = 1;\r
 194         PMADDR = 0x0000;\r
 195         vTaskDelay( lcdSHORT_DELAY );\r
 196 \r
 197         /* Set the default function. */\r
 198         PMDIN1 = lcdDEFAULT_FUNCTION;\r
 199         vTaskDelay( lcdSHORT_DELAY );\r
 200 \r
 201         /* Set the display control. */\r
 202         PMDIN1 = lcdDISPLAY_CONTROL;\r
 203         vTaskDelay( lcdSHORT_DELAY );\r
 204 \r
 205         /* Clear the display. */\r
 206         PMDIN1 = lcdCLEAR_DISPLAY;\r
 207         vTaskDelay( lcdSHORT_DELAY );\r
 208 \r
 209         /* Set the entry mode. */\r
 210         PMDIN1 = lcdENTRY_MODE;\r
 211         vTaskDelay( lcdSHORT_DELAY );\r
 212 }\r
 213 /*-----------------------------------------------------------*/\r
 214 \r
 215 static void vLCDTask( void *pvParameters )\r
 216 {\r
 217 xLCDMessage xMessage;\r
 218 unsigned portSHORT usRow = 0;\r
 219 \r
 220         /* Initialise the hardware.  This uses delays so must not be called prior\r
 221         to the scheduler being started. */\r
 222         prvSetupLCD();\r
 223 \r
 224         /* Welcome message. */\r
 225         prvLCDPutString( "www.FreeRTOS.org" );\r
 226 \r
 227         for( ;; )\r
 228         {\r
 229                 /* Wait for a message to arrive that requires displaying. */\r
 230                 while( xQueueReceive( xLCDQueue, &xMessage, portMAX_DELAY ) != pdPASS );\r
 231 \r
 232                 /* Clear the current display value. */\r
 233                 prvLCDClear();\r
 234 \r
 235                 /* Switch rows each time so we can see that the display is still being\r
 236                 updated. */\r
 237                 prvLCDGotoRow( usRow & 0x01 );\r
 238                 usRow++;\r
 239                 prvLCDPutString( xMessage.pcMessage );\r
 240 \r
 241                 /* Delay the requested amount of time to ensure the text just written \r
 242                 to the LCD is not overwritten. */\r
 243                 vTaskDelay( xMessage.xMinDisplayTime );         \r
 244         }\r
 245 }\r
 246 \r
 247 \r
 248 \r
 249 \r