Display Driver and Example for Waveshare 1.28 Round LCD (#77)

* Added board waveshare-rp2040-lcd-1-28

.gitignore

@@ -3,3 +3,4 @@ target
 Cargo.lock
 .vscode
 *.orig
+*.raw

Cargo.toml

@@ -26,6 +26,7 @@ members = [
     "boards/vcc-gnd-yd-rp2040",
     "boards/waveshare-rp2040-zero",
     "boards/waveshare-rp2040-lcd-0-96",
+	"boards/waveshare-rp2040-lcd-1-28",
 ]
 
 [workspace.dependencies]
@@ -62,3 +63,4 @@ usb-device = "0.3.1"
 usbd-hid = "0.7.0"
 usbd-serial = "0.2.1"
 ws2812-pio = "0.8.0"
+gc9a01a_driver = "0.1.3"

boards/waveshare-rp2040-lcd-1-28/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## Unreleased
+
+## 0.1.0 - 2024-07-29
+
+### Changed
+
+- Inital release
+- Copied from waveshare-rp2040-0.96
+- Update board name
+

boards/waveshare-rp2040-lcd-1-28/Cargo.toml

@@ -0,0 +1,51 @@
+[package]
+name = "waveshare-rp2040-lcd-1-28"
+version = "0.8.0"
+authors = ["René van Dorst <opensource@vdorst.com>", "Andrea Nall <anall@andreanal.com>", "TilCreator <contact.github@tc-j.de>", "The rp-rs Developers"]
+edition = "2018"
+homepage = "https://github.com/rp-rs/rp-hal-boards/tree/main/boards/waveshare-rp2040-lcd-0_96"
+description = "Board Support Package for the Waveshare RP2040 LCD 0.96 inch"
+license = "MIT OR Apache-2.0"
+repository = "https://github.com/rp-rs/rp-hal-boards.git"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+cortex-m-rt = { workspace = true, optional = true }
+rp2040-boot2 = { workspace = true, optional = true }
+rp2040-hal.workspace = true
+
+[dev-dependencies]
+cortex-m.workspace = true
+panic-halt.workspace = true
+embedded-hal.workspace = true
+fugit.workspace = true
+nb.workspace = true
+embedded-graphics.workspace = true
+gc9a01a_driver = { workspace = true }
+
+[features]
+# This is the set of features we enable by default
+default = ["boot2", "rt", "critical-section-impl", "rom-func-cache"]
+
+# critical section that is safe for multicore use
+critical-section-impl = ["rp2040-hal/critical-section-impl"]
+
+# 2nd stage bootloaders for rp2040
+boot2 = ["rp2040-boot2"]
+
+# Minimal startup / runtime for Cortex-M microcontrollers
+rt = ["cortex-m-rt","rp2040-hal/rt"]
+
+# This enables a fix for USB errata 5: USB device fails to exit RESET state on busy USB bus.
+# Only required for RP2040 B0 and RP2040 B1, but it doesn't hurt to enable it
+rp2040-e5 = ["rp2040-hal/rp2040-e5"]
+
+# Memoize(cache) ROM function pointers on first use to improve performance
+rom-func-cache = ["rp2040-hal/rom-func-cache"]
+
+# Disable automatic mapping of language features (like floating point math) to ROM functions
+disable-intrinsics = ["rp2040-hal/disable-intrinsics"]
+
+# This enables ROM functions for f64 math that were not present in the earliest RP2040s
+rom-v2-intrinsics = ["rp2040-hal/rom-v2-intrinsics"]

boards/waveshare-rp2040-lcd-1-28/README.md

@@ -0,0 +1,97 @@
+# [waveshare-rp2040-lcd-1-28] - Board Support for the [Waveshare RP2040 LCD 1.28]
+
+You should include this crate if you are writing code that you want to run on
+an [Waveshare RP2040 LCD 1.28] - a very small RP2040 breakout board with USB-C, 
+a 65K IPS LCD 240x240, 16MBit Flash and 1A battery charger from Waveshare.
+
+This crate includes the [rp2040-hal], but also configures each pin of the
+RP2040 chip according to how it is connected up on the Feather.
+
+[Waveshare RP2040 LCD 1.28]: https://www.waveshare.com/wiki/RP2040-LCD-1.28
+[waveshare-rp2040-lcd-1-28]: https://github.com/rp-rs/rp-hal-boards/tree/main/boards/waveshare-rp2040-lcd-1-28
+[rp2040-hal]: https://github.com/rp-rs/rp-hal/tree/main/rp2040-hal
+[Raspberry Silicon RP2040]: https://www.raspberrypi.org/products/rp2040/
+
+## Using
+
+To use this crate, your `Cargo.toml` file should contain:
+
+```toml
+waveshare_rp2040_lcd_1_28 = "0.8.0"
+```
+
+In your program, you will need to call `waveshare_rp2040_lcd_1_28::Pins::new` to create
+a new `Pins` structure. This will set up all the GPIOs for any on-board
+devices. See the [examples](./examples) folder for more details.
+
+## Examples
+
+### General Instructions
+
+To compile an example, clone the _rp-hal-boards_ repository and run:
+
+```console
+rp-hal-boards/boards/waveshare-rp2040-lcd-1-28 $ cargo build --release --example <name>
+```
+
+You will get an ELF file called
+`./target/thumbv6m-none-eabi/release/examples/<name>`, where the `target`
+folder is located at the top of the _rp-hal-boards_ repository checkout. Normally
+you would also need to specify `--target=thumbv6m-none-eabi` but when
+building examples from this git repository, that is set as the default.
+
+If you want to convert the ELF file to a UF2 and automatically copy it to the
+USB drive exported by the RP2040 bootloader, simply boot your board into
+bootloader mode and run:
+
+```console
+rp-hal-boards/boards/waveshare-rp2040-lcd-1-28 $ cargo run --release --example <name>
+```
+
+If you get an error about not being able to find `elf2uf2-rs`, try:
+
+```console
+$ cargo install elf2uf2-rs, then repeating the `cargo run` command above.
+```
+
+### [waveshare_rp2040_lcd_demo](./examples/waveshare_rp2040_lcd_demo.rs)
+
+Draws a red and green line with a blue regtangle.
+After that is fills the screen line for line, that end it starts over with an
+other colour, RED, GREEN and BLUE.
+
+## Contributing
+
+Contributions are what make the open source community such an amazing place to
+be, learn, inspire, and create. Any contributions you make are **greatly
+appreciated**.
+
+The steps are:
+
+1. Fork the Project by clicking the 'Fork' button at the top of the page.
+2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
+3. Make some changes to the code or documentation.
+4. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
+5. Push to the Feature Branch (`git push origin feature/AmazingFeature`)
+6. Create a [New Pull Request](https://github.com/rp-rs/rp-hal-boards/pulls)
+7. An admin will review the Pull Request and discuss any changes that may be required.
+8. Once everyone is happy, the Pull Request can be merged by an admin, and your work is part of our project!
+
+## Code of Conduct
+
+Contribution to this crate is organized under the terms of the [Rust Code of
+Conduct][CoC], and the maintainer of this crate, the [rp-rs team], promises
+to intervene to uphold that code of conduct.
+
+[CoC]: CODE_OF_CONDUCT.md
+[rp-rs team]: https://github.com/orgs/rp-rs/teams/rp-rs
+
+## License
+
+The contents of this repository are dual-licensed under the _MIT OR Apache
+2.0_ License. That means you can choose either the MIT license or the
+Apache-2.0 license when you re-use this code. See `MIT` or `APACHE2.0` for more
+information on each specific license.
+
+Any submissions to this project (e.g. as Pull Requests) must be made available
+under these terms.

boards/waveshare-rp2040-lcd-1-28/examples/waveshare_rp2040_lcd_demo.rs

@@ -0,0 +1,163 @@
+//! Example of graphics on the LCD of the Waveshare RP2040-LCD-1.28
+//!
+//! Draws a red and green line with a blue rectangle.
+//! After that it fills the screen line for line, at the end it starts over with
+//! another colour, RED, GREEN and BLUE.
+#![no_std]
+#![no_main]
+
+use cortex_m::delay::Delay;
+use fugit::RateExtU32;
+use gc9a01a_driver::{Orientation, GC9A01A};
+use panic_halt as _;
+
+use waveshare_rp2040_lcd_1_28::entry;
+use waveshare_rp2040_lcd_1_28::{
+    hal::{
+        self,
+        clocks::{init_clocks_and_plls, Clock},
+        pac,
+        pio::PIOExt,
+        watchdog::Watchdog,
+        Sio,
+    },
+    Pins, XOSC_CRYSTAL_FREQ,
+};
+
+use embedded_graphics::{
+    pixelcolor::Rgb565,
+    prelude::*,
+    primitives::{Line, PrimitiveStyle, PrimitiveStyleBuilder, Rectangle},
+};
+
+const LCD_WIDTH: u32 = 240;
+const LCD_HEIGHT: u32 = 240;
+// Define static buffers
+
+/// Main entry point for the application
+#[entry]
+fn main() -> ! {
+    // Take ownership of peripheral instances
+    let mut pac = pac::Peripherals::take().unwrap();
+    let core = pac::CorePeripherals::take().unwrap();
+
+    // Initialize watchdog
+    let mut watchdog = Watchdog::new(pac.WATCHDOG);
+
+    // Initialize clocks and PLLs
+    let clocks = init_clocks_and_plls(
+        XOSC_CRYSTAL_FREQ,
+        pac.XOSC,
+        pac.CLOCKS,
+        pac.PLL_SYS,
+        pac.PLL_USB,
+        &mut pac.RESETS,
+        &mut watchdog,
+    )
+    .ok()
+    .unwrap();
+
+    // Initialize SIO
+    let sio = Sio::new(pac.SIO);
+    let pins = Pins::new(
+        pac.IO_BANK0,
+        pac.PADS_BANK0,
+        sio.gpio_bank0,
+        &mut pac.RESETS,
+    );
+
+    // Set up the delay for the first core
+    let sys_freq = clocks.system_clock.freq().to_Hz();
+    let mut delay = Delay::new(core.SYST, sys_freq);
+
+    let (mut _pio, _sm0, _, _, _) = pac.PIO0.split(&mut pac.RESETS);
+
+    // Initialize LCD pins
+    let lcd_dc = pins.gp8.into_push_pull_output();
+    let lcd_cs = pins.gp9.into_push_pull_output();
+    let lcd_clk = pins.gp10.into_function::<hal::gpio::FunctionSpi>();
+    let lcd_mosi = pins.gp11.into_function::<hal::gpio::FunctionSpi>();
+    let lcd_rst = pins
+        .gp12
+        .into_push_pull_output_in_state(hal::gpio::PinState::High);
+    let mut _lcd_bl = pins
+        .gp25
+        .into_push_pull_output_in_state(hal::gpio::PinState::Low);
+
+    // Initialize SPI
+    let spi = hal::Spi::<_, _, _, 8>::new(pac.SPI1, (lcd_mosi, lcd_clk));
+    let spi = spi.init(
+        &mut pac.RESETS,
+        clocks.peripheral_clock.freq(),
+        40.MHz(),
+        embedded_hal::spi::MODE_0,
+    );
+
+    // Initialize the display
+    let mut display = GC9A01A::new(spi, lcd_dc, lcd_cs, lcd_rst, false, LCD_WIDTH, LCD_HEIGHT);
+    display.init(&mut delay).unwrap();
+    display.set_orientation(&Orientation::Landscape).unwrap();
+
+    // Clear the screen before turning on the backlight
+    display.clear(Rgb565::BLACK).unwrap();
+    _lcd_bl.into_push_pull_output_in_state(hal::gpio::PinState::High);
+    delay.delay_ms(1000);
+
+    let lcd_zero = Point::zero();
+    let lcd_max_corner = Point::new((LCD_WIDTH - 1) as i32, (LCD_HEIGHT - 1) as i32);
+
+    let style = PrimitiveStyleBuilder::new()
+        .fill_color(Rgb565::BLUE)
+        .build();
+
+    Rectangle::with_corners(lcd_zero, lcd_max_corner)
+        .into_styled(style)
+        .draw(&mut display)
+        .unwrap();
+    delay.delay_ms(1000);
+
+    let style = PrimitiveStyleBuilder::new()
+        .fill_color(Rgb565::BLACK)
+        .build();
+
+    Rectangle::with_corners(
+        Point::new(1, 1),
+        Point::new((LCD_WIDTH - 2) as i32, (LCD_HEIGHT - 2) as i32),
+    )
+    .into_styled(style)
+    .draw(&mut display)
+    .unwrap();
+
+    Line::new(lcd_zero, lcd_max_corner)
+        .into_styled(PrimitiveStyle::with_stroke(Rgb565::RED, 1))
+        .draw(&mut display)
+        .unwrap();
+
+    Line::new(
+        Point::new(0, (LCD_HEIGHT - 1) as i32),
+        Point::new((LCD_WIDTH - 1) as i32, 0),
+    )
+    .into_styled(PrimitiveStyle::with_stroke(Rgb565::GREEN, 1))
+    .draw(&mut display)
+    .unwrap();
+
+    // Infinite colour wheel loop
+    let mut l: i32 = 0;
+    let mut c = Rgb565::RED;
+    loop {
+        Line::new(Point::new(0, l), Point::new((LCD_WIDTH - 1) as i32, l))
+            .into_styled(PrimitiveStyle::with_stroke(c, 1))
+            .draw(&mut display)
+            .unwrap();
+        delay.delay_ms(10);
+        l += 1;
+        if l == LCD_HEIGHT as i32 {
+            l = 0;
+            c = match c {
+                Rgb565::RED => Rgb565::GREEN,
+                Rgb565::GREEN => Rgb565::BLUE,
+                _ => Rgb565::RED,
+            }
+        }
+    }
+}