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

   1 /*\r
   2         FreeRTOS V5.4.0 - Copyright (C) 2003-2009 Richard Barry.\r
   3 \r
   4         This file is part of the FreeRTOS distribution.\r
   5 \r
   6         FreeRTOS is free software; you can redistribute it and/or modify it     under \r
   7         the terms of the GNU General Public License (version 2) as published by the \r
   8         Free Software Foundation and modified by the FreeRTOS exception.\r
   9         **NOTE** The exception to the GPL is included to allow you to distribute a\r
  10         combined work that includes FreeRTOS without being obliged to provide the \r
  11         source code for proprietary components outside of the FreeRTOS kernel.  \r
  12         Alternative commercial license and support terms are also available upon \r
  13         request.  See the licensing section of http://www.FreeRTOS.org for full \r
  14         license details.\r
  15 \r
  16         FreeRTOS is distributed in the hope that it will be useful,     but WITHOUT\r
  17         ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\r
  18         FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for\r
  19         more details.\r
  20 \r
  21         You should have received a copy of the GNU General Public License along\r
  22         with FreeRTOS; if not, write to the Free Software Foundation, Inc., 59\r
  23         Temple Place, Suite 330, Boston, MA  02111-1307  USA.\r
  24 \r
  25 \r
  26         ***************************************************************************\r
  27         *                                                                         *\r
  28         * Looking for a quick start?  Then check out the FreeRTOS eBook!          *\r
  29         * See http://www.FreeRTOS.org/Documentation for details                   *\r
  30         *                                                                         *\r
  31         ***************************************************************************\r
  32 \r
  33         1 tab == 4 spaces!\r
  34 \r
  35         Please ensure to read the configuration and relevant port sections of the\r
  36         online documentation.\r
  37 \r
  38         http://www.FreeRTOS.org - Documentation, latest information, license and\r
  39         contact details.\r
  40 \r
  41         http://www.SafeRTOS.com - A version that is certified for use in safety\r
  42         critical systems.\r
  43 \r
  44         http://www.OpenRTOS.com - Commercial support, development, porting,\r
  45         licensing and training services.\r
  46 */\r
  47 \r
  48 /* peripheral library include */\r
  49 #include <plib.h>\r
  50 \r
  51 /* Scheduler includes. */\r
  52 #include "FreeRTOS.h"\r
  53 #include "task.h"\r
  54 #include "queue.h"\r
  55 \r
  56 /* Demo includes. */\r
  57 #include "lcd.h"\r
  58 \r
  59 /*\r
  60  * The LCD is written to by more than one task so is controlled by this\r
  61  * 'gatekeeper' task.  This is the only task that is actually permitted to\r
  62  * access the LCD directly.  Other tasks wanting to display a message send\r
  63  * the message to the gatekeeper.\r
  64  */\r
  65 static void vLCDTask( void *pvParameters );\r
  66 \r
  67 /*\r
  68  * Setup the peripherals required to communicate with the LCD.\r
  69  */\r
  70 static void prvSetupLCD( void );\r
  71 \r
  72 /* \r
  73  * Move to the first (0) or second (1) row of the LCD. \r
  74  */\r
  75 static void prvLCDGotoRow( unsigned portSHORT usRow );\r
  76 \r
  77 /* \r
  78  * Write a string of text to the LCD. \r
  79  */\r
  80 static void prvLCDPutString( portCHAR *pcString );\r
  81 \r
  82 /* \r
  83  * Clear the LCD. \r
  84  */\r
  85 static void prvLCDClear( void );\r
  86 \r
  87 /*-----------------------------------------------------------*/\r
  88 \r
  89 /* Brief delay to permit the LCD to catch up with commands. */\r
  90 #define lcdVERY_SHORT_DELAY     ( 1 )\r
  91 #define lcdSHORT_DELAY          ( 4 / portTICK_RATE_MS )\r
  92 #define lcdLONG_DELAY           ( 15 / portTICK_RATE_MS )\r
  93 \r
  94 /* LCD specific definitions. */\r
  95 #define LCD_CLEAR_DISPLAY_CMD                   0x01\r
  96 #define LCD_CURSOR_HOME_CMD                             0x02\r
  97 #define LCD_ENTRY_MODE_CMD                              0x04\r
  98 #define LCD_ENTRY_MODE_INCREASE                 0x02\r
  99 #define LCD_DISPLAY_CTRL_CMD                    0x08\r
 100 #define LCD_DISPLAY_CTRL_DISPLAY_ON             0x04\r
 101 #define LCD_FUNCTION_SET_CMD                    0x20\r
 102 #define LCD_FUNCTION_SET_8_BITS                 0x10\r
 103 #define LCD_FUNCTION_SET_2_LINES                0x08\r
 104 #define LCD_FUNCTION_SET_LRG_FONT               0x04\r
 105 #define LCD_NEW_LINE                                    0xC0\r
 106 #define LCD_COMMAND_ADDRESS                             0x00\r
 107 #define LCD_DATA_ADDRESS                                0x01\r
 108 \r
 109 /* The length of the queue used to send messages to the LCD gatekeeper task. */\r
 110 #define lcdQUEUE_SIZE           3\r
 111 \r
 112 /*-----------------------------------------------------------*/\r
 113 \r
 114 /* The queue used to send messages to the LCD task. */\r
 115 xQueueHandle xLCDQueue;\r
 116 \r
 117 /* LCD access functions. */\r
 118 static void prvLCDCommand( portCHAR cCommand );\r
 119 static void prvLCDData( portCHAR cChar );\r
 120 \r
 121 /*-----------------------------------------------------------*/\r
 122 \r
 123 xQueueHandle xStartLCDTask( void )\r
 124 {\r
 125         /* Create the queue used by the LCD task.  Messages for display on the LCD\r
 126         are received via this queue. */\r
 127         xLCDQueue = xQueueCreate( lcdQUEUE_SIZE, sizeof( xLCDMessage ));\r
 128 \r
 129         /* Start the task that will write to the LCD.  The LCD hardware is\r
 130         initialised from within the task itself so delays can be used. */\r
 131         xTaskCreate( vLCDTask, ( signed portCHAR * ) "LCD", configMINIMAL_STACK_SIZE, NULL, tskIDLE_PRIORITY + 1, NULL );\r
 132 \r
 133         return xLCDQueue;\r
 134 }\r
 135 /*-----------------------------------------------------------*/\r
 136 \r
 137 static void prvLCDGotoRow( unsigned portSHORT usRow )\r
 138 {\r
 139         if(usRow == 0) \r
 140         {\r
 141                 prvLCDCommand( LCD_CURSOR_HOME_CMD );\r
 142         } \r
 143         else \r
 144         {\r
 145                 prvLCDCommand( LCD_NEW_LINE );\r
 146         }\r
 147 }\r
 148 /*-----------------------------------------------------------*/\r
 149 \r
 150 static void prvLCDCommand( portCHAR cCommand ) \r
 151 {\r
 152         PMPSetAddress( LCD_COMMAND_ADDRESS );\r
 153         PMPMasterWrite( cCommand );\r
 154         vTaskDelay( lcdSHORT_DELAY );\r
 155 }\r
 156 /*-----------------------------------------------------------*/\r
 157 \r
 158 static void prvLCDData( portCHAR cChar )\r
 159 {\r
 160         PMPSetAddress( LCD_DATA_ADDRESS );\r
 161         PMPMasterWrite( cChar );\r
 162         vTaskDelay( lcdVERY_SHORT_DELAY );\r
 163 }\r
 164 /*-----------------------------------------------------------*/\r
 165 \r
 166 static void prvLCDPutString( portCHAR *pcString )\r
 167 {\r
 168         /* Write out each character with appropriate delay between each. */\r
 169         while(*pcString)\r
 170         {\r
 171                 prvLCDData(*pcString);\r
 172                 pcString++;\r
 173                 vTaskDelay(lcdSHORT_DELAY);\r
 174         }\r
 175 }\r
 176 /*-----------------------------------------------------------*/\r
 177 \r
 178 static void prvLCDClear(void)\r
 179 {\r
 180         prvLCDCommand(LCD_CLEAR_DISPLAY_CMD);\r
 181 }\r
 182 /*-----------------------------------------------------------*/\r
 183 \r
 184 static void prvSetupLCD(void)\r
 185 {\r
 186         /* Wait for proper power up. */\r
 187         vTaskDelay( lcdLONG_DELAY );\r
 188         \r
 189         /* Open the PMP port */\r
 190         mPMPOpen((PMP_ON | PMP_READ_WRITE_EN | PMP_CS2_CS1_EN |\r
 191                           PMP_LATCH_POL_HI | PMP_CS2_POL_HI | PMP_CS1_POL_HI |\r
 192                           PMP_WRITE_POL_HI | PMP_READ_POL_HI),\r
 193                          (PMP_MODE_MASTER1 | PMP_WAIT_BEG_4 | PMP_WAIT_MID_15 |\r
 194                           PMP_WAIT_END_4),\r
 195                           PMP_PEN_0, 0);\r
 196                          \r
 197         /* Wait for the LCD to power up correctly. */\r
 198         vTaskDelay( lcdLONG_DELAY );\r
 199         vTaskDelay( lcdLONG_DELAY );\r
 200         vTaskDelay( lcdLONG_DELAY );\r
 201 \r
 202         /* Set up the LCD function. */\r
 203         prvLCDCommand( LCD_FUNCTION_SET_CMD | LCD_FUNCTION_SET_8_BITS | LCD_FUNCTION_SET_2_LINES | LCD_FUNCTION_SET_LRG_FONT );\r
 204         \r
 205         /* Turn the display on. */\r
 206         prvLCDCommand( LCD_DISPLAY_CTRL_CMD | LCD_DISPLAY_CTRL_DISPLAY_ON );\r
 207         \r
 208         /* Clear the display. */\r
 209         prvLCDCommand( LCD_CLEAR_DISPLAY_CMD );\r
 210         vTaskDelay( lcdLONG_DELAY );    \r
 211         \r
 212         /* Increase the cursor. */\r
 213         prvLCDCommand( LCD_ENTRY_MODE_CMD | LCD_ENTRY_MODE_INCREASE );\r
 214         vTaskDelay( lcdLONG_DELAY );                    \r
 215         vTaskDelay( lcdLONG_DELAY );                    \r
 216         vTaskDelay( lcdLONG_DELAY );\r
 217 }\r
 218 /*-----------------------------------------------------------*/\r
 219 \r
 220 static void vLCDTask(void *pvParameters)\r
 221 {\r
 222 xLCDMessage xMessage;\r
 223 unsigned portSHORT usRow = 0;\r
 224 \r
 225         /* Initialise the hardware.  This uses delays so must not be called prior\r
 226         to the scheduler being started. */\r
 227         prvSetupLCD();\r
 228 \r
 229         /* Welcome message. */\r
 230         prvLCDPutString( "www.FreeRTOS.org" );\r
 231 \r
 232         for(;;)\r
 233         {\r
 234                 /* Wait for a message to arrive that requires displaying. */\r
 235                 while( xQueueReceive( xLCDQueue, &xMessage, portMAX_DELAY ) != pdPASS );\r
 236 \r
 237                 /* Clear the current display value. */\r
 238                 prvLCDClear();\r
 239 \r
 240                 /* Switch rows each time so we can see that the display is still being\r
 241                 updated. */\r
 242                 prvLCDGotoRow( usRow & 0x01 );\r
 243                 usRow++;\r
 244                 prvLCDPutString( xMessage.pcMessage );\r
 245 \r
 246                 /* Delay the requested amount of time to ensure the text just written \r
 247                 to the LCD is not overwritten. */\r
 248                 vTaskDelay( xMessage.xMinDisplayTime );         \r
 249         }\r
 250 }\r
 251 \r
 252 \r
 253 \r
 254 \r