Quick Start Guide for the LCDCA Driver

This is the quick start guide for the SAM4L Liquid Crystal Display (LCDCA) Driver, with step-by-step instructions on how to configure and use the driver for a specific use case.

The use cases contain several code fragments. The code fragments in the steps for setup can be copied into a custom initialization function, while the steps for usage can be copied into, for example, the main application function.

Use Cases

• LCDCA Basic Usage

LCDCA Basic Usage

This use case will demonstrate how to configure and use the LCDCA module to address an external LCD segment (C42048A).

Setup Steps

Prerequisites

This module requires the following services:

• System clock (sysclk)
• Sleep Manager
• Peripheral DMA Controller (PDCA) driver

Setup Code Example

Add these code segments to the main loop, or to a setup function in your application's C-file:

#define PORT_MASK  40
#define LCD_DUTY   LCDCA_DUTY_1_4
#define LCD_CONTRAST_LEVEL 30

struct lcdca_config lcdca_cfg; 

    // LCDCA Controller initialization
    // - Clock,
    // - Connect to C42364A glass LCD component,
    // - Timing:  64 Hz frame rate & low power waveform, FC0, FC1, FC2
    // - Interrupt: off.
    lcdca_clk_init();
    lcdca_cfg.port_mask = PORT_MASK;
    lcdca_cfg.x_bias = false;
    lcdca_cfg.lp_wave = true;
    lcdca_cfg.duty_type = LCD_DUTY;
    lcdca_cfg.lcd_pres = false;
    lcdca_cfg.lcd_clkdiv = 3;
    lcdca_cfg.fc0 = 16;
    lcdca_cfg.fc1 = 2;
    lcdca_cfg.fc2 = 6;
    lcdca_cfg.contrast = LCD_CONTRAST_LEVEL;
    lcdca_set_config(&lcdca_cfg);
    lcdca_enable();
    lcdca_enable_timer(LCDCA_TIMER_FC0);
    lcdca_enable_timer(LCDCA_TIMER_FC1);
    lcdca_enable_timer(LCDCA_TIMER_FC2);

    /* Turn on LCD back light */
    ioport_set_pin_level(LCD_BL_GPIO, IOPORT_PIN_LEVEL_HIGH);

Basic Setup Workflow

1. Initialize the LCDCA clock:

       lcdca_clk_init();

2. Configure the LCDCA module:

       lcdca_set_config(&lcdca_cfg);

3. Enable the LCDCA module:

       lcdca_enable();

4. Enable the frame counter timers:

       lcdca_enable_timer(LCDCA_TIMER_FC0);
       lcdca_enable_timer(LCDCA_TIMER_FC1);
       lcdca_enable_timer(LCDCA_TIMER_FC2);

5. Turn on the LCD backlight:

       ioport_set_pin_level(LCD_BL_GPIO, IOPORT_PIN_LEVEL_HIGH);

Usage Steps

Normal Usage

The following functions can be used to set/clear/toggle one pixel/segment:

lcdca_set_pixel(ICON_ARM); 

lcdca_clear_pixel(ICON_ARM); 

lcdca_toggle_pixel(ICON_ARM); 

The function lcdca_write_packet() can be used to display ASCII characters:

    // Display in alphanumeric field.
    lcdca_write_packet(LCDCA_TDG_14SEG4COM, FIRST_14SEG_4C, data, \
            WIDTH_14SEG_4C, DIR_14SEG_4C);

    // Display in numeric field.
    lcdca_write_packet(LCDCA_TDG_7SEG4COM, FIRST_7SEG_4C, data, \
            WIDTH_7SEG_4C, DIR_7SEG_4C);

The LCD contrast can be changed using:

lcdca_set_contrast(contrast_value); 

Using Hardware Blinking

To use hardware blinking:

    blink_cfg.lcd_blink_timer = LCDCA_TIMER_FC1;
    blink_cfg.lcd_blink_mode = LCDCA_BLINK_SELECTED;
    lcdca_blink_set_config(&blink_cfg);
    lcdca_set_pixel(ICON_ERROR);
    lcdca_set_blink_pixel(ICON_ERROR);
    lcdca_blink_enable();

Using Hardware Autonomous Animation

To use the hardware's autonomous segment animation:

    cs_cfg.lcd_csr_timer = LCDCA_TIMER_FC1;
    cs_cfg.lcd_csr_dir = LCDCA_CSR_RIGHT;
    cs_cfg.size = 7;    // Total 7-pixels.
    cs_cfg.data = 0x03; // Display 2 pixel at one time.
    lcdca_circular_shift_set_config(&cs_cfg);
    lcdca_circular_shift_enable();

Using Hardware Automated Character

To use hardware automated character (e.g., scrolling here):

    struct lcdca_automated_char_config automated_char_cfg;

    uint8_t const scrolling_str[] = \
        "Scrolling string display, Press PB0 to cont.  ";

    automated_char_cfg.automated_mode = LCDCA_AUTOMATED_MODE_SCROLLING;
    automated_char_cfg.automated_timer = LCDCA_TIMER_FC2;
    automated_char_cfg.lcd_tdg = LCDCA_TDG_14SEG4COM;
    automated_char_cfg.stseg = FIRST_14SEG_4C;
    automated_char_cfg.dign = WIDTH_14SEG_4C;
    /* STEPS = string length - DIGN + 1 */
    automated_char_cfg.steps = sizeof(scrolling_str) - WIDTH_14SEG_4C + 1;
    automated_char_cfg.dir_reverse = LCDCA_AUTOMATED_DIR_REVERSE;
    lcdca_automated_char_set_config(&automated_char_cfg);
    lcdca_automated_char_start(scrolling_str, strlen((char const *)scrolling_str));