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

   1 /*\r
   2         FreeRTOS.org V4.6.1 - Copyright (C) 2003-2007 Richard Barry.\r
   3 \r
   4         This file is part of the FreeRTOS.org distribution.\r
   5 \r
   6         FreeRTOS.org is free software; you can redistribute it and/or modify\r
   7         it under the terms of the GNU General Public License as published by\r
   8         the Free Software Foundation; either version 2 of the License, or\r
   9         (at your option) any later version.\r
  10 \r
  11         FreeRTOS.org is distributed in the hope that it will be useful,\r
  12         but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  13         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  14         GNU General Public License for more details.\r
  15 \r
  16         You should have received a copy of the GNU General Public License\r
  17         along with FreeRTOS.org; if not, write to the Free Software\r
  18         Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA\r
  19 \r
  20         A special exception to the GPL can be applied should you wish to distribute\r
  21         a combined work that includes FreeRTOS.org, without being obliged to provide\r
  22         the source code for any proprietary components.  See the licensing section \r
  23         of http://www.FreeRTOS.org for full details of how and when the exception\r
  24         can be applied.\r
  25 \r
  26         ***************************************************************************\r
  27         See http://www.FreeRTOS.org for documentation, latest information, license \r
  28         and contact details.  Please ensure to read the configuration and relevant \r
  29         port sections of the online documentation.\r
  30 \r
  31         Also see http://www.SafeRTOS.com a version that has been certified for use\r
  32         in safety critical systems, plus commercial licensing, development and\r
  33         support options.\r
  34         ***************************************************************************\r
  35 */\r
  36 \r
  37 /* Scheduler includes. */\r
  38 #include "FreeRTOS.h"\r
  39 #include "task.h"\r
  40 #include "queue.h"\r
  41 \r
  42 /* Demo includes. */\r
  43 #include "lcd.h"\r
  44 \r
  45 /*\r
  46  * The LCD is written to by more than one task so is controlled by this\r
  47  * 'gatekeeper' task.  This is the only task that is actually permitted to\r
  48  * access the LCD directly.  Other tasks wanting to display a message send\r
  49  * the message to the gatekeeper.\r
  50  */\r
  51 static void vLCDTask( void *pvParameters );\r
  52 \r
  53 /*\r
  54  * Setup the peripherals required to communicate with the LCD.\r
  55  */\r
  56 static void prvSetupLCD( void );\r
  57 \r
  58 /* \r
  59  * Move to the first (0) or second (1) row of the LCD. \r
  60  */\r
  61 static void prvLCDGotoRow( unsigned portSHORT usRow );\r
  62 \r
  63 /* \r
  64  * Write a string of text to the LCD. \r
  65  */\r
  66 static void prvLCDPutString( portCHAR *pcString );\r
  67 \r
  68 /* \r
  69  * Clear the LCD. \r
  70  */\r
  71 static void prvLCDClear( void );\r
  72 \r
  73 /*-----------------------------------------------------------*/\r
  74 \r
  75 /* Brief delay to permit the LCD to catch up with commands. */\r
  76 #define lcdSHORT_DELAY          3\r
  77 \r
  78 /* SFR that seems to be missing from the standard header files. */\r
  79 #define PMAEN                           *( ( unsigned short * ) 0x60c )\r
  80 \r
  81 /* LCD commands. */\r
  82 #define lcdDEFAULT_FUNCTION     0x3c\r
  83 #define lcdDISPLAY_CONTROL      0x0c\r
  84 #define lcdCLEAR_DISPLAY        0x01\r
  85 #define lcdENTRY_MODE           0x06\r
  86 \r
  87 /* The length of the queue used to send messages to the LCD gatekeeper task. */\r
  88 #define lcdQUEUE_SIZE           3\r
  89 /*-----------------------------------------------------------*/\r
  90 \r
  91 /* The queue used to send messages to the LCD task. */\r
  92 xQueueHandle xLCDQueue;\r
  93 \r
  94 \r
  95 /*-----------------------------------------------------------*/\r
  96 \r
  97 xQueueHandle xStartLCDTask( void )\r
  98 {\r
  99         /* Create the queue used by the LCD task.  Messages for display on the LCD\r
 100         are received via this queue. */\r
 101         xLCDQueue = xQueueCreate( lcdQUEUE_SIZE, sizeof( xLCDMessage ) );\r
 102 \r
 103         /* Start the task that will write to the LCD.  The LCD hardware is\r
 104         initialised from within the task itself so delays can be used. */\r
 105         xTaskCreate( vLCDTask, ( signed portCHAR * ) "LCD", configMINIMAL_STACK_SIZE, NULL, tskIDLE_PRIORITY + 1, NULL );\r
 106 \r
 107         return xLCDQueue;\r
 108 }\r
 109 /*-----------------------------------------------------------*/\r
 110 \r
 111 static void prvLCDGotoRow( unsigned portSHORT usRow )\r
 112 {\r
 113         if( usRow == 0 )\r
 114         {\r
 115                 PMADDR = 0x0000;\r
 116                 PMDIN1 = 0x02;\r
 117         }\r
 118         else\r
 119         {\r
 120                 PMADDR = 0x0000;\r
 121                 PMDIN1 = 0xc0;\r
 122         }\r
 123 \r
 124         vTaskDelay( lcdSHORT_DELAY );\r
 125 }\r
 126 /*-----------------------------------------------------------*/\r
 127 \r
 128 static void prvLCDPutString( portCHAR *pcString )\r
 129 {\r
 130         /* Write out each character with appropriate delay between each. */\r
 131         while( *pcString )\r
 132         {\r
 133                 PMADDR = 0x0001;\r
 134                 PMDIN1 = *pcString;\r
 135                 pcString++;\r
 136                 vTaskDelay( lcdSHORT_DELAY );\r
 137         }\r
 138 }\r
 139 /*-----------------------------------------------------------*/\r
 140 \r
 141 static void prvLCDClear( void )\r
 142 {\r
 143         /* Clear the display. */\r
 144         PMADDR = 0x0000;\r
 145         PMDIN1 = lcdCLEAR_DISPLAY;\r
 146         vTaskDelay( lcdSHORT_DELAY );   \r
 147 }\r
 148 /*-----------------------------------------------------------*/\r
 149 \r
 150 static void prvSetupLCD( void )\r
 151 {\r
 152         /* Setup the PMP. */\r
 153         PMCON = 0x83BF;\r
 154         PMMODE = 0x3FF;\r
 155         PMAEN = 1;\r
 156         PMADDR = 0x0000;\r
 157         vTaskDelay( lcdSHORT_DELAY );\r
 158 \r
 159         /* Set the default function. */\r
 160         PMDIN1 = lcdDEFAULT_FUNCTION;\r
 161         vTaskDelay( lcdSHORT_DELAY );\r
 162 \r
 163         /* Set the display control. */\r
 164         PMDIN1 = lcdDISPLAY_CONTROL;\r
 165         vTaskDelay( lcdSHORT_DELAY );\r
 166 \r
 167         /* Clear the display. */\r
 168         PMDIN1 = lcdCLEAR_DISPLAY;\r
 169         vTaskDelay( lcdSHORT_DELAY );\r
 170 \r
 171         /* Set the entry mode. */\r
 172         PMDIN1 = lcdENTRY_MODE;\r
 173         vTaskDelay( lcdSHORT_DELAY );\r
 174 }\r
 175 /*-----------------------------------------------------------*/\r
 176 \r
 177 static void vLCDTask( void *pvParameters )\r
 178 {\r
 179 xLCDMessage xMessage;\r
 180 unsigned portSHORT usRow = 0;\r
 181 \r
 182         /* Initialise the hardware.  This uses delays so must not be called prior\r
 183         to the scheduler being started. */\r
 184         prvSetupLCD();\r
 185 \r
 186         /* Welcome message. */\r
 187         prvLCDPutString( "www.FreeRTOS.org" );\r
 188 \r
 189         for( ;; )\r
 190         {\r
 191                 /* Wait for a message to arrive that requires displaying. */\r
 192                 while( xQueueReceive( xLCDQueue, &xMessage, portMAX_DELAY ) != pdPASS );\r
 193 \r
 194                 /* Clear the current display value. */\r
 195                 prvLCDClear();\r
 196 \r
 197                 /* Switch rows each time so we can see that the display is still being\r
 198                 updated. */\r
 199                 prvLCDGotoRow( usRow & 0x01 );\r
 200                 usRow++;\r
 201                 prvLCDPutString( xMessage.pcMessage );\r
 202 \r
 203                 /* Delay the requested amount of time to ensure the text just written \r
 204                 to the LCD is not overwritten. */\r
 205                 vTaskDelay( xMessage.xMinDisplayTime );         \r
 206         }\r
 207 }\r
 208 \r
 209 \r
 210 \r
 211 \r