mbed library sources
Dependents: frdm_kl05z_gpio_test
Fork of mbed-src by
targets/cmsis/TARGET_STM/TARGET_NUCLEO_L053R8/stm32l0xx_hal_lcd.c
- Committer:
- mbed_official
- Date:
- 2014-05-07
- Revision:
- 181:a4cbdfbbd2f4
File content as of revision 181:a4cbdfbbd2f4:
/** ****************************************************************************** * @file stm32l0xx_hal_lcd.c * @author MCD Application Team * @version V1.0.0 * @date 22-April-2014 * @brief LCD Controller HAL module driver. * This file provides firmware functions to manage the following * functionalities of the LCD Controller (LCD) peripheral: * + Initialization/de-initialization methods * + I/O operation methods * + Peripheral State methods * @verbatim ============================================================================== ##### How to use this driver ##### ============================================================================== [..] The LCD HAL driver can be used as follows: (#) Declare a LCD_HandleTypeDef handle structure. (#) Initialize the LCD low level resources by implement the HAL_LCD_MspInit() API: (##) Enable the LCDCLK (same as RTCCLK): to configure the RTCCLK/LCDCLK, proceed as follows: (+) Enable the Power Controller (PWR) APB1 interface clock using the __PWR_CLK_ENABLE() macro. (+) Enable access to RTC domain using the HAL_PWR_EnableBkUpAccess() function. (+) Select the RTC clock source using the __HAL_RCC_RTC_CONFIG() function. (@) The frequency generator allows you to achieve various LCD frame rates starting from an LCD input clock frequency (LCDCLK) which can vary from 32 kHz up to 1 MHz. (##) LCD pins configuration: (+) Enable the clock for the LCD GPIOs. (+) Configure these LCD pins as alternate function no-pull. (##) Enable the LCD interface clock. (#) Program the Prescaler, Divider, Blink mode, Blink Frequency Duty, Bias, Voltage Source, Dead Time, Pulse On Duration and Contrast in the hlcd Init structure. (#) Initialize the LCD registers by calling the HAL_LCD_Init() API. (@) The HAL_LCD_Init() API configures also the low level Hardware GPIO, CLOCK, ...etc) by calling the custumed HAL_LCD_MspInit() API. (@) After calling the HAL_LCD_Init() the LCD RAM memory is cleared (#) Optionally you can update the LCD configuration using these macros: - LCD High Drive using the __HAL_LCD_HIGHDRIVER_ENABLE() and __HAL_LCD_HIGHDRIVER_DISABLE() macros - LCD Pulse ON Duration using the __HAL_LCD_PULSEONDURATION_CONFIG() macro - LCD Dead Time using the __HAL_LCD_DEADTIME_CONFIG() macro - The LCD Blink mode and frequency using the __HAL_LCD_BLINK_CONFIG() macro - The LCD Contrast using the __HAL_LCD_CONTRAST_CONFIG() macro (#) Write to the LCD RAM memory using the HAL_LCD_Write() API, this API can be called more time to update the different LCD RAM registers before calling HAL_LCD_UpdateDisplayRequest() API. (#) The HAL_LCD_Clear() API can be used to clear the LCD RAM memory. (#) When LCD RAM memory is updated enable the update display request using the HAL_LCD_UpdateDisplayRequest() API. [..] LCD and low power modes: (#) The LCD still active during STOP mode. @endverbatim ****************************************************************************** * @attention * * <h2><center>© COPYRIGHT(c) 2014 STMicroelectronics</center></h2> * * Redistribution and use in source and binary forms, with or without modification, * are permitted provided that the following conditions are met: * 1. Redistributions of source code must retain the above copyright notice, * this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright notice, * this list of conditions and the following disclaimer in the documentation * and/or other materials provided with the distribution. * 3. Neither the name of STMicroelectronics nor the names of its contributors * may be used to endorse or promote products derived from this software * without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * ****************************************************************************** */ /* Includes ------------------------------------------------------------------*/ #include "stm32l0xx_hal.h" /** @addtogroup STM32L0xx_HAL_Driver * @{ */ /** @defgroup LCD * @brief LCD HAL module driver * @{ */ #ifdef HAL_LCD_MODULE_ENABLED #if !defined (STM32L051xx) && !defined (STM32L052xx) && !defined (STM32L062xx) && !defined (STM32L061xx) /* Private typedef -----------------------------------------------------------*/ /* Private define ------------------------------------------------------------*/ #define LCD_TIMEOUT_VALUE 1000 /* Private macro -------------------------------------------------------------*/ /* Private variables ---------------------------------------------------------*/ /* Private function prototypes -----------------------------------------------*/ /* Private functions ---------------------------------------------------------*/ /** @defgroup LCD_Private_Functions * @{ */ /** @defgroup HAL_LCD_Group1 Initialization/de-initialization methods * @brief Initialization and Configuration functions * @verbatim =============================================================================== ##### Initialization and Configuration functions ##### =============================================================================== [..] @endverbatim * @{ */ /** * @brief DeInitializes the LCD peripheral. * @param hlcd: LCD handle * @retval HAL status */ HAL_StatusTypeDef HAL_LCD_DeInit(LCD_HandleTypeDef *hlcd) { /* Check the LCD handle allocation */ if(hlcd == NULL) { return HAL_ERROR; } /* Check the parameters */ assert_param(IS_LCD_ALL_INSTANCE(hlcd->Instance)); hlcd->State = HAL_LCD_STATE_BUSY; /* DeInit the low level hardware */ HAL_LCD_MspDeInit(hlcd); hlcd->ErrorCode = HAL_LCD_ERROR_NONE; hlcd->State = HAL_LCD_STATE_RESET; /* Release Lock */ __HAL_UNLOCK(hlcd); return HAL_OK; } /** * @brief Initializes the LCD peripheral according to the specified parameters * in the LCD_InitStruct. * @note This function can be used only when the LCD is disabled. * @param hlcd: LCD handle * @retval None */ HAL_StatusTypeDef HAL_LCD_Init(LCD_HandleTypeDef *hlcd) { uint32_t tickstart = 0x00; uint8_t counter = 0; /* Check the LCD handle allocation */ if(hlcd == NULL) { return HAL_ERROR; } /* Check function parameters */ assert_param(IS_LCD_ALL_INSTANCE(hlcd->Instance)); assert_param(IS_LCD_PRESCALER(hlcd->Init.Prescaler)); assert_param(IS_LCD_DIVIDER(hlcd->Init.Divider)); assert_param(IS_LCD_DUTY(hlcd->Init.Duty)); assert_param(IS_LCD_BIAS(hlcd->Init.Bias)); assert_param(IS_LCD_VOLTAGE_SOURCE(hlcd->Init.VoltageSource)); assert_param(IS_LCD_PULSE_ON_DURATION(hlcd->Init.PulseOnDuration)); assert_param(IS_LCD_DEAD_TIME(hlcd->Init.DeadTime)); assert_param(IS_LCD_CONTRAST(hlcd->Init.Contrast)); assert_param(IS_LCD_BLINK_FREQUENCY(hlcd->Init.BlinkFrequency)); assert_param(IS_LCD_BLINK_MODE(hlcd->Init.BlinkMode)); if(hlcd->State == HAL_LCD_STATE_RESET) { /* Initialize the low level hardware (MSP) */ HAL_LCD_MspInit(hlcd); } hlcd->State = HAL_LCD_STATE_BUSY; /* Disable the peripheral */ __HAL_LCD_DISABLE(hlcd); /* Clear the LCD_RAM registers and enable the display request by setting the UDR bit in the LCD_SR register */ for(counter = LCD_RAM_REGISTER0; counter <= LCD_RAM_REGISTER15; counter++) { hlcd->Instance->RAM[counter] = 0; } /* Enable the display request */ hlcd->Instance->SR |= LCD_SR_UDR; /* Configure the LCD Prescaler, Divider, Blink mode and Blink Frequency: Set PS[3:0] bits according to hlcd->Init.Prescaler value Set DIV[3:0] bits according to hlcd->Init.Divider value Set BLINK[1:0] bits according to hlcd->Init.BlinkMode value Set BLINKF[2:0] bits according to hlcd->Init.BlinkFrequency value Set DEAD[2:0] bits according to hlcd->Init.DeadTime value Set PON[2:0] bits according to hlcd->Init.PulseOnDuration value Set CC[2:0] bits according to hlcd->Init.Contrast value */ hlcd->Instance->FCR = (uint32_t)(hlcd->Init.Prescaler | hlcd->Init.Divider | \ hlcd->Init.BlinkMode | hlcd->Init.BlinkFrequency | \ hlcd->Init.DeadTime | hlcd->Init.PulseOnDuration | \ hlcd->Init.Contrast); /* Wait until LCD Frame Control Register Synchronization flag (FCRSF) is set in the LCD_SR register This bit is set by hardware each time the LCD_FCR register is updated in the LCDCLK domain. It is cleared by hardware when writing to the LCD_FCR register.*/ LCD_WaitForSynchro(hlcd); /* Configure the LCD Duty, Bias, Voltage Source, Dead Time, Pulse On Duration and Contrast: Set DUTY[2:0] bits according to hlcd->Init.Duty value Set BIAS[1:0] bits according to hlcd->Init.Bias value Set VSEL bits according to hlcd->Init.VoltageSource value */ hlcd->Instance->CR = (uint32_t)(hlcd->Init.Duty | hlcd->Init.Bias | \ hlcd->Init.VoltageSource); /* Enable the peripheral */ __HAL_LCD_ENABLE(hlcd); /* Get timeout */ tickstart = HAL_GetTick(); /* Wait Until the LCD is enabled */ while((hlcd->Instance->SR & LCD_FLAG_ENS) == (uint32_t)RESET) { if((HAL_GetTick() - tickstart ) > LCD_TIMEOUT_VALUE) { hlcd->ErrorCode = HAL_LCD_ERROR_ENS; return HAL_TIMEOUT; } } /* Get timeout */ tickstart = HAL_GetTick(); /*!< Wait Until the LCD Booster is ready */ while((hlcd->Instance->SR & LCD_FLAG_RDY) == (uint32_t)RESET) { if((HAL_GetTick() - tickstart ) > LCD_TIMEOUT_VALUE) { hlcd->ErrorCode = HAL_LCD_ERROR_RDY; return HAL_TIMEOUT; } } /* Initialize the LCD state */ hlcd->ErrorCode = HAL_LCD_ERROR_NONE; hlcd->State= HAL_LCD_STATE_READY; return HAL_OK; } /** * @brief LCD MSP DeInit. * @param hlcd: LCD handle * @retval None */ __weak void HAL_LCD_MspDeInit(LCD_HandleTypeDef *hlcd) { /* NOTE: This function Should not be modified, when the callback is needed, the HAL_LCD_MspDeInit could be implemented in the user file */ } /** * @brief LCD MSP Init. * @param hlcd: LCD handle * @retval None */ __weak void HAL_LCD_MspInit(LCD_HandleTypeDef *hlcd) { /* NOTE: This function Should not be modified, when the callback is needed, the HAL_LCD_MspInit could be implemented in the user file */ } /** * @} */ /** @defgroup HAL_LCD_Group2 IO operation methods * @brief LCD RAM functions * @verbatim =============================================================================== ##### I/O operation methods ##### =============================================================================== [..] Using its double buffer memory the LCD controller ensures the coherency of the displayed information without having to use interrupts to control LCD_RAM modification. The application software can access the first buffer level (LCD_RAM) through the APB interface. Once it has modified the LCD_RAM using the HAL_LCD_Write() API, it sets the UDR flag in the LCD_SR register using the HAL_LCD_UpdateDisplayRequest() API. This UDR flag (update display request) requests the updated information to be moved into the second buffer level (LCD_DISPLAY). This operation is done synchronously with the frame (at the beginning of the next frame), until the update is completed, the LCD_RAM is write protected and the UDR flag stays high. Once the update is completed another flag (UDD - Update Display Done) is set and generates an interrupt if the UDDIE bit in the LCD_FCR register is set. The time it takes to update LCD_DISPLAY is, in the worst case, one odd and one even frame. The update will not occur (UDR = 1 and UDD = 0) until the display is enabled (LCDEN = 1). @endverbatim * @{ */ /** * @brief Writes a word in the specific LCD RAM. * @param hlcd: LCD handle * @param RAMRegisterIndex: specifies the LCD RAM Register. * This parameter can be one of the following values: * @arg LCD_RAM_REGISTER0: LCD RAM Register 0 * @arg LCD_RAM_REGISTER1: LCD RAM Register 1 * @arg LCD_RAM_REGISTER2: LCD RAM Register 2 * @arg LCD_RAM_REGISTER3: LCD RAM Register 3 * @arg LCD_RAM_REGISTER4: LCD RAM Register 4 * @arg LCD_RAM_REGISTER5: LCD RAM Register 5 * @arg LCD_RAM_REGISTER6: LCD RAM Register 6 * @arg LCD_RAM_REGISTER7: LCD RAM Register 7 * @arg LCD_RAM_REGISTER8: LCD RAM Register 8 * @arg LCD_RAM_REGISTER9: LCD RAM Register 9 * @arg LCD_RAM_REGISTER10: LCD RAM Register 10 * @arg LCD_RAM_REGISTER11: LCD RAM Register 11 * @arg LCD_RAM_REGISTER12: LCD RAM Register 12 * @arg LCD_RAM_REGISTER13: LCD RAM Register 13 * @arg LCD_RAM_REGISTER14: LCD RAM Register 14 * @arg LCD_RAM_REGISTER15: LCD RAM Register 15 * @param RAMRegisterMask: specifies the LCD RAM Register Data Mask. * @param Data: specifies LCD Data Value to be written. * @retval None */ HAL_StatusTypeDef HAL_LCD_Write(LCD_HandleTypeDef *hlcd, uint32_t RAMRegisterIndex, uint32_t RAMRegisterMask, uint32_t Data) { uint32_t tickstart = 0x00; if((hlcd->State == HAL_LCD_STATE_READY) || (hlcd->State == HAL_LCD_STATE_BUSY)) { /* Check the parameters */ assert_param(IS_LCD_RAM_REGISTER(RAMRegisterIndex)); if(hlcd->State == HAL_LCD_STATE_READY) { /* Process Locked */ __HAL_LOCK(hlcd); hlcd->State = HAL_LCD_STATE_BUSY; /* Get timeout */ tickstart = HAL_GetTick(); /*!< Wait Until the LCD is ready */ while((hlcd->Instance->SR & LCD_FLAG_UDR) != (uint32_t)RESET) { if((int32_t) (HAL_GetTick() - tickstart) > LCD_TIMEOUT_VALUE) { hlcd->ErrorCode = HAL_LCD_ERROR_UDR; return HAL_TIMEOUT; } } } /* Clear the data bytes position into LCD RAM register */ hlcd->Instance->RAM[RAMRegisterIndex] &= (uint32_t)RAMRegisterMask; /* Copy the new Data bytes to LCD RAM register */ hlcd->Instance->RAM[RAMRegisterIndex] |= (uint32_t)Data; return HAL_OK; } else { return HAL_ERROR; } } /** * @brief Clears the LCD RAM registers. * @param hlcd: LCD handle * @retval None */ HAL_StatusTypeDef HAL_LCD_Clear(LCD_HandleTypeDef *hlcd) { uint32_t tickstart = 0x00; uint32_t counter = 0; if((hlcd->State == HAL_LCD_STATE_READY) || (hlcd->State == HAL_LCD_STATE_BUSY)) { /* Process Locked */ __HAL_LOCK(hlcd); hlcd->State = HAL_LCD_STATE_BUSY; /* Get timeout */ tickstart = HAL_GetTick(); /*!< Wait Until the LCD is ready */ while((hlcd->Instance->SR & LCD_FLAG_UDR) != (uint32_t)RESET) { if((int32_t) (HAL_GetTick() - tickstart) > LCD_TIMEOUT_VALUE) { hlcd->ErrorCode = HAL_LCD_ERROR_UDR; return HAL_TIMEOUT; } } /* Clear the LCD_RAM registers */ for(counter = LCD_RAM_REGISTER0; counter <= LCD_RAM_REGISTER15; counter++) { hlcd->Instance->RAM[counter] = 0; } /* Update the LCD display */ HAL_LCD_UpdateDisplayRequest(hlcd); return HAL_OK; } else { return HAL_ERROR; } } /** * @brief Enables the Update Display Request. * @param hlcd: LCD handle * @note Each time software modifies the LCD_RAM it must set the UDR bit to * transfer the updated data to the second level buffer. * The UDR bit stays set until the end of the update and during this * time the LCD_RAM is write protected. * @note When the display is disabled, the update is performed for all * LCD_DISPLAY locations. * When the display is enabled, the update is performed only for locations * for which commons are active (depending on DUTY). For example if * DUTY = 1/2, only the LCD_DISPLAY of COM0 and COM1 will be updated. * @retval None */ HAL_StatusTypeDef HAL_LCD_UpdateDisplayRequest(LCD_HandleTypeDef *hlcd) { uint32_t tickstart = 0x00; /* Clear the Update Display Done flag before starting the update display request */ __HAL_LCD_CLEAR_FLAG(hlcd, LCD_FLAG_UDD); /* Enable the display request */ hlcd->Instance->SR |= LCD_SR_UDR; /* Get timeout */ tickstart = HAL_GetTick(); /*!< Wait Until the LCD display is done */ while((hlcd->Instance->SR & LCD_FLAG_UDD) == (uint32_t)RESET) { if((int32_t) (HAL_GetTick() - tickstart) > LCD_TIMEOUT_VALUE) { hlcd->ErrorCode = HAL_LCD_ERROR_UDD; return HAL_TIMEOUT; } } hlcd->State = HAL_LCD_STATE_READY; /* Process Unlocked */ __HAL_UNLOCK(hlcd); return HAL_OK; } /** * @} */ /** @defgroup HAL_LCD_Group3 Peripheral State methods * @brief LCD State functions * @verbatim =============================================================================== ##### Peripheral State methods ##### =============================================================================== [..] This subsection provides a set of functions allowing to control the LCD: (+) HAL_LCD_GetState() API can be helpful to check in run-time the state of the LCD peripheral State. (+) HAL_LCD_GetError() API to return the LCD error code. @endverbatim * @{ */ /** * @brief Returns the LCD state. * @param hlcd: LCD handle * @retval HAL state */ HAL_LCD_StateTypeDef HAL_LCD_GetState(LCD_HandleTypeDef *hlcd) { return hlcd->State; } /** * @brief Return the LCD error code * @param hlcd: LCD handle * @retval LCD Error Code */ uint32_t HAL_LCD_GetError(LCD_HandleTypeDef *hlcd) { return hlcd->ErrorCode; } /** * @} */ /** * @brief Waits until the LCD FCR register is synchronized in the LCDCLK domain. * This function must be called after any write operation to LCD_FCR register. * @param None * @retval None */ HAL_StatusTypeDef LCD_WaitForSynchro(LCD_HandleTypeDef *hlcd) { uint32_t tickstart = 0x00; /* Get timeout */ tickstart = HAL_GetTick(); /* Loop until FCRSF flag is set */ while((hlcd->Instance->SR & LCD_FLAG_FCRSF) == (uint32_t)RESET) { if((int32_t) (HAL_GetTick() - tickstart) > LCD_TIMEOUT_VALUE) { hlcd->ErrorCode = HAL_LCD_ERROR_FCRSF; return HAL_TIMEOUT; } } return HAL_OK; } /** * @} */ #endif /* STM32L051xx && STM32L052xx && STM32L062xx && STM32L061xx*/ #endif /* HAL_LCD_MODULE_ENABLED */ /** * @} */ /** * @} */ /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/