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

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