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

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