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

   1 /*\r
   2     FreeRTOS V7.1.1 - 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 /* Scheduler includes. */\r
  68 #include "FreeRTOS.h"\r
  69 #include "task.h"\r
  70 #include "queue.h"\r
  71 \r
  72 /* Demo includes. */\r
  73 #include "lcd.h"\r
  74 \r
  75 /*\r
  76  * The LCD is written to by more than one task so is controlled by this\r
  77  * 'gatekeeper' task.  This is the only task that is actually permitted to\r
  78  * access the LCD directly.  Other tasks wanting to display a message send\r
  79  * the message to the gatekeeper.\r
  80  */\r
  81 static void vLCDTask( void *pvParameters );\r
  82 \r
  83 /*\r
  84  * Setup the peripherals required to communicate with the LCD.\r
  85  */\r
  86 static void prvSetupLCD( void );\r
  87 \r
  88 /* \r
  89  * Move to the first (0) or second (1) row of the LCD. \r
  90  */\r
  91 static void prvLCDGotoRow( unsigned portSHORT usRow );\r
  92 \r
  93 /* \r
  94  * Write a string of text to the LCD. \r
  95  */\r
  96 static void prvLCDPutString( portCHAR *pcString );\r
  97 \r
  98 /* \r
  99  * Clear the LCD. \r
 100  */\r
 101 static void prvLCDClear( void );\r
 102 \r
 103 /*-----------------------------------------------------------*/\r
 104 \r
 105 /* Brief delay to permit the LCD to catch up with commands. */\r
 106 #define lcdSHORT_DELAY          3\r
 107 \r
 108 /* SFR that seems to be missing from the standard header files. */\r
 109 #define PMAEN                           *( ( unsigned short * ) 0x60c )\r
 110 \r
 111 /* LCD commands. */\r
 112 #define lcdDEFAULT_FUNCTION     0x3c\r
 113 #define lcdDISPLAY_CONTROL      0x0c\r
 114 #define lcdCLEAR_DISPLAY        0x01\r
 115 #define lcdENTRY_MODE           0x06\r
 116 \r
 117 /* The length of the queue used to send messages to the LCD gatekeeper task. */\r
 118 #define lcdQUEUE_SIZE           3\r
 119 /*-----------------------------------------------------------*/\r
 120 \r
 121 /* The queue used to send messages to the LCD task. */\r
 122 xQueueHandle xLCDQueue;\r
 123 \r
 124 \r
 125 /*-----------------------------------------------------------*/\r
 126 \r
 127 xQueueHandle xStartLCDTask( void )\r
 128 {\r
 129         /* Create the queue used by the LCD task.  Messages for display on the LCD\r
 130         are received via this queue. */\r
 131         xLCDQueue = xQueueCreate( lcdQUEUE_SIZE, sizeof( xLCDMessage ) );\r
 132 \r
 133         /* Start the task that will write to the LCD.  The LCD hardware is\r
 134         initialised from within the task itself so delays can be used. */\r
 135         xTaskCreate( vLCDTask, ( signed portCHAR * ) "LCD", configMINIMAL_STACK_SIZE, NULL, tskIDLE_PRIORITY + 1, NULL );\r
 136 \r
 137         return xLCDQueue;\r
 138 }\r
 139 /*-----------------------------------------------------------*/\r
 140 \r
 141 static void prvLCDGotoRow( unsigned portSHORT usRow )\r
 142 {\r
 143         if( usRow == 0 )\r
 144         {\r
 145                 PMADDR = 0x0000;\r
 146                 PMDIN1 = 0x02;\r
 147         }\r
 148         else\r
 149         {\r
 150                 PMADDR = 0x0000;\r
 151                 PMDIN1 = 0xc0;\r
 152         }\r
 153 \r
 154         vTaskDelay( lcdSHORT_DELAY );\r
 155 }\r
 156 /*-----------------------------------------------------------*/\r
 157 \r
 158 static void prvLCDPutString( portCHAR *pcString )\r
 159 {\r
 160         /* Write out each character with appropriate delay between each. */\r
 161         while( *pcString )\r
 162         {\r
 163                 PMADDR = 0x0001;\r
 164                 PMDIN1 = *pcString;\r
 165                 pcString++;\r
 166                 vTaskDelay( lcdSHORT_DELAY );\r
 167         }\r
 168 }\r
 169 /*-----------------------------------------------------------*/\r
 170 \r
 171 static void prvLCDClear( void )\r
 172 {\r
 173         /* Clear the display. */\r
 174         PMADDR = 0x0000;\r
 175         PMDIN1 = lcdCLEAR_DISPLAY;\r
 176         vTaskDelay( lcdSHORT_DELAY );   \r
 177 }\r
 178 /*-----------------------------------------------------------*/\r
 179 \r
 180 static void prvSetupLCD( void )\r
 181 {\r
 182         /* Setup the PMP. */\r
 183         PMCON = 0x83BF;\r
 184         PMMODE = 0x3FF;\r
 185         PMAEN = 1;\r
 186         PMADDR = 0x0000;\r
 187         vTaskDelay( lcdSHORT_DELAY );\r
 188 \r
 189         /* Set the default function. */\r
 190         PMDIN1 = lcdDEFAULT_FUNCTION;\r
 191         vTaskDelay( lcdSHORT_DELAY );\r
 192 \r
 193         /* Set the display control. */\r
 194         PMDIN1 = lcdDISPLAY_CONTROL;\r
 195         vTaskDelay( lcdSHORT_DELAY );\r
 196 \r
 197         /* Clear the display. */\r
 198         PMDIN1 = lcdCLEAR_DISPLAY;\r
 199         vTaskDelay( lcdSHORT_DELAY );\r
 200 \r
 201         /* Set the entry mode. */\r
 202         PMDIN1 = lcdENTRY_MODE;\r
 203         vTaskDelay( lcdSHORT_DELAY );\r
 204 }\r
 205 /*-----------------------------------------------------------*/\r
 206 \r
 207 static void vLCDTask( void *pvParameters )\r
 208 {\r
 209 xLCDMessage xMessage;\r
 210 unsigned portSHORT usRow = 0;\r
 211 \r
 212         /* Initialise the hardware.  This uses delays so must not be called prior\r
 213         to the scheduler being started. */\r
 214         prvSetupLCD();\r
 215 \r
 216         /* Welcome message. */\r
 217         prvLCDPutString( "www.FreeRTOS.org" );\r
 218 \r
 219         for( ;; )\r
 220         {\r
 221                 /* Wait for a message to arrive that requires displaying. */\r
 222                 while( xQueueReceive( xLCDQueue, &xMessage, portMAX_DELAY ) != pdPASS );\r
 223 \r
 224                 /* Clear the current display value. */\r
 225                 prvLCDClear();\r
 226 \r
 227                 /* Switch rows each time so we can see that the display is still being\r
 228                 updated. */\r
 229                 prvLCDGotoRow( usRow & 0x01 );\r
 230                 usRow++;\r
 231                 prvLCDPutString( xMessage.pcMessage );\r
 232 \r
 233                 /* Delay the requested amount of time to ensure the text just written \r
 234                 to the LCD is not overwritten. */\r
 235                 vTaskDelay( xMessage.xMinDisplayTime );         \r
 236         }\r
 237 }\r
 238 \r
 239 \r
 240 \r
 241 \r