git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/PIC32MX_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 /* peripheral library include */\r
  76 #include <plib.h>\r
  77 \r
  78 /* Scheduler includes. */\r
  79 #include "FreeRTOS.h"\r
  80 #include "task.h"\r
  81 #include "queue.h"\r
  82 \r
  83 /* Demo includes. */\r
  84 #include "lcd.h"\r
  85 \r
  86 /*\r
  87  * The LCD is written to by more than one task so is controlled by this\r
  88  * 'gatekeeper' task.  This is the only task that is actually permitted to\r
  89  * access the LCD directly.  Other tasks wanting to display a message send\r
  90  * the message to the gatekeeper.\r
  91  */\r
  92 static void vLCDTask( void *pvParameters );\r
  93 \r
  94 /*\r
  95  * Setup the peripherals required to communicate with the LCD.\r
  96  */\r
  97 static void prvSetupLCD( void );\r
  98 \r
  99 /* \r
 100  * Move to the first (0) or second (1) row of the LCD. \r
 101  */\r
 102 static void prvLCDGotoRow( unsigned short usRow );\r
 103 \r
 104 /* \r
 105  * Write a string of text to the LCD. \r
 106  */\r
 107 static void prvLCDPutString( char *pcString );\r
 108 \r
 109 /* \r
 110  * Clear the LCD. \r
 111  */\r
 112 static void prvLCDClear( void );\r
 113 \r
 114 /*-----------------------------------------------------------*/\r
 115 \r
 116 /* Brief delay to permit the LCD to catch up with commands. */\r
 117 #define lcdVERY_SHORT_DELAY     ( 1 )\r
 118 #define lcdSHORT_DELAY          ( 4 / portTICK_RATE_MS )\r
 119 #define lcdLONG_DELAY           ( 15 / portTICK_RATE_MS )\r
 120 \r
 121 /* LCD specific definitions. */\r
 122 #define LCD_CLEAR_DISPLAY_CMD                   0x01\r
 123 #define LCD_CURSOR_HOME_CMD                             0x02\r
 124 #define LCD_ENTRY_MODE_CMD                              0x04\r
 125 #define LCD_ENTRY_MODE_INCREASE                 0x02\r
 126 #define LCD_DISPLAY_CTRL_CMD                    0x08\r
 127 #define LCD_DISPLAY_CTRL_DISPLAY_ON             0x04\r
 128 #define LCD_FUNCTION_SET_CMD                    0x20\r
 129 #define LCD_FUNCTION_SET_8_BITS                 0x10\r
 130 #define LCD_FUNCTION_SET_2_LINES                0x08\r
 131 #define LCD_FUNCTION_SET_LRG_FONT               0x04\r
 132 #define LCD_NEW_LINE                                    0xC0\r
 133 #define LCD_COMMAND_ADDRESS                             0x00\r
 134 #define LCD_DATA_ADDRESS                                0x01\r
 135 \r
 136 /* The length of the queue used to send messages to the LCD gatekeeper task. */\r
 137 #define lcdQUEUE_SIZE           3\r
 138 \r
 139 /*-----------------------------------------------------------*/\r
 140 \r
 141 /* The queue used to send messages to the LCD task. */\r
 142 xQueueHandle xLCDQueue;\r
 143 \r
 144 /* LCD access functions. */\r
 145 static void prvLCDCommand( char cCommand );\r
 146 static void prvLCDData( char cChar );\r
 147 \r
 148 /*-----------------------------------------------------------*/\r
 149 \r
 150 xQueueHandle xStartLCDTask( void )\r
 151 {\r
 152         /* Create the queue used by the LCD task.  Messages for display on the LCD\r
 153         are received via this queue. */\r
 154         xLCDQueue = xQueueCreate( lcdQUEUE_SIZE, sizeof( xLCDMessage ));\r
 155 \r
 156         /* Start the task that will write to the LCD.  The LCD hardware is\r
 157         initialised from within the task itself so delays can be used. */\r
 158         xTaskCreate( vLCDTask, ( signed char * ) "LCD", configMINIMAL_STACK_SIZE, NULL, tskIDLE_PRIORITY + 1, NULL );\r
 159 \r
 160         return xLCDQueue;\r
 161 }\r
 162 /*-----------------------------------------------------------*/\r
 163 \r
 164 static void prvLCDGotoRow( unsigned short usRow )\r
 165 {\r
 166         if(usRow == 0) \r
 167         {\r
 168                 prvLCDCommand( LCD_CURSOR_HOME_CMD );\r
 169         } \r
 170         else \r
 171         {\r
 172                 prvLCDCommand( LCD_NEW_LINE );\r
 173         }\r
 174 }\r
 175 /*-----------------------------------------------------------*/\r
 176 \r
 177 static void prvLCDCommand( char cCommand ) \r
 178 {\r
 179         PMPSetAddress( LCD_COMMAND_ADDRESS );\r
 180         PMPMasterWrite( cCommand );\r
 181         vTaskDelay( lcdSHORT_DELAY );\r
 182 }\r
 183 /*-----------------------------------------------------------*/\r
 184 \r
 185 static void prvLCDData( char cChar )\r
 186 {\r
 187         PMPSetAddress( LCD_DATA_ADDRESS );\r
 188         PMPMasterWrite( cChar );\r
 189         vTaskDelay( lcdVERY_SHORT_DELAY );\r
 190 }\r
 191 /*-----------------------------------------------------------*/\r
 192 \r
 193 static void prvLCDPutString( char *pcString )\r
 194 {\r
 195         /* Write out each character with appropriate delay between each. */\r
 196         while(*pcString)\r
 197         {\r
 198                 prvLCDData(*pcString);\r
 199                 pcString++;\r
 200                 vTaskDelay(lcdSHORT_DELAY);\r
 201         }\r
 202 }\r
 203 /*-----------------------------------------------------------*/\r
 204 \r
 205 static void prvLCDClear(void)\r
 206 {\r
 207         prvLCDCommand(LCD_CLEAR_DISPLAY_CMD);\r
 208 }\r
 209 /*-----------------------------------------------------------*/\r
 210 \r
 211 static void prvSetupLCD(void)\r
 212 {\r
 213         /* Wait for proper power up. */\r
 214         vTaskDelay( lcdLONG_DELAY );\r
 215         \r
 216         /* Open the PMP port */\r
 217         mPMPOpen((PMP_ON | PMP_READ_WRITE_EN | PMP_CS2_CS1_EN |\r
 218                           PMP_LATCH_POL_HI | PMP_CS2_POL_HI | PMP_CS1_POL_HI |\r
 219                           PMP_WRITE_POL_HI | PMP_READ_POL_HI),\r
 220                          (PMP_MODE_MASTER1 | PMP_WAIT_BEG_4 | PMP_WAIT_MID_15 |\r
 221                           PMP_WAIT_END_4),\r
 222                           PMP_PEN_0, 0);\r
 223                          \r
 224         /* Wait for the LCD to power up correctly. */\r
 225         vTaskDelay( lcdLONG_DELAY );\r
 226         vTaskDelay( lcdLONG_DELAY );\r
 227         vTaskDelay( lcdLONG_DELAY );\r
 228 \r
 229         /* Set up the LCD function. */\r
 230         prvLCDCommand( LCD_FUNCTION_SET_CMD | LCD_FUNCTION_SET_8_BITS | LCD_FUNCTION_SET_2_LINES | LCD_FUNCTION_SET_LRG_FONT );\r
 231         \r
 232         /* Turn the display on. */\r
 233         prvLCDCommand( LCD_DISPLAY_CTRL_CMD | LCD_DISPLAY_CTRL_DISPLAY_ON );\r
 234         \r
 235         /* Clear the display. */\r
 236         prvLCDCommand( LCD_CLEAR_DISPLAY_CMD );\r
 237         vTaskDelay( lcdLONG_DELAY );    \r
 238         \r
 239         /* Increase the cursor. */\r
 240         prvLCDCommand( LCD_ENTRY_MODE_CMD | LCD_ENTRY_MODE_INCREASE );\r
 241         vTaskDelay( lcdLONG_DELAY );                    \r
 242         vTaskDelay( lcdLONG_DELAY );                    \r
 243         vTaskDelay( lcdLONG_DELAY );\r
 244 }\r
 245 /*-----------------------------------------------------------*/\r
 246 \r
 247 static void vLCDTask(void *pvParameters)\r
 248 {\r
 249 xLCDMessage xMessage;\r
 250 unsigned short usRow = 0;\r
 251 \r
 252         /* Initialise the hardware.  This uses delays so must not be called prior\r
 253         to the scheduler being started. */\r
 254         prvSetupLCD();\r
 255 \r
 256         /* Welcome message. */\r
 257         prvLCDPutString( "www.FreeRTOS.org" );\r
 258 \r
 259         for(;;)\r
 260         {\r
 261                 /* Wait for a message to arrive that requires displaying. */\r
 262                 while( xQueueReceive( xLCDQueue, &xMessage, portMAX_DELAY ) != pdPASS );\r
 263 \r
 264                 /* Clear the current display value. */\r
 265                 prvLCDClear();\r
 266 \r
 267                 /* Switch rows each time so we can see that the display is still being\r
 268                 updated. */\r
 269                 prvLCDGotoRow( usRow & 0x01 );\r
 270                 usRow++;\r
 271                 prvLCDPutString( xMessage.pcMessage );\r
 272 \r
 273                 /* Delay the requested amount of time to ensure the text just written \r
 274                 to the LCD is not overwritten. */\r
 275                 vTaskDelay( xMessage.xMinDisplayTime );         \r
 276         }\r
 277 }\r
 278 \r
 279 \r
 280 \r
 281 \r