TODO.md

TODO List - PicoCalc Lyra Build System

This document tracks known issues, work-in-progress features, and planned improvements for the PicoCalc LuckFox Lyra build system.

🚨 Critical Issues (Not Working)

Audio System

• Stereo hardware PWM audio - Audio output is not yet fully functional
  • Current DTS configuration exists but driver integration incomplete
  • PWM channels configured in device tree: pwm0_4ch_0 channels 1 & 2
  • Custom sound card driver (fsl,picocalc-snd-pwm) needs work
  • Priority: High

WiFi Connectivity

• ✅ RTL8188FU WiFi driver - Driver builds but WiFi not functional

🔧 Build System Improvements

Releases

• Working automated releases - Releases are suppoosed to be cut when tags are updated, but the github action for this is rough, largely autogenerated, and does not complete
• automated PR tests - a test workflow should run when a PR is submitted to ensure full functionality before merging

USB Flashing

• ✅ Automatic ADB reboot for flashing - Use ADB to automatically reboot device into loader mode

• ✅ Fix SD card ejection for reboot loader - Device hangs during reboot if external SD card is inserted

📦 Package System

RTL8188FU Driver Package

• ✅ Package creation - BuildRoot package exists
• ✅ Firmware installation - Configured in package makefile
• ✅ Driver debugging - Investigate why WiFi doesn't work
• ✅ Kernel config validation - Ensure all required options enabled

Audio Packages

• ALSA utilities - Add alsa-utils package for audio debugging
• Audio testing tools - Add speaker-test, aplay utilities
• Sound card detection - Verify ALSA can see the PWM sound device

🖥️ System Integration

Device Tree

• ✅ Basic hardware support - SD card, USB, I2C, SPI working
• ✅ Display support - ILI9488 LCD working
• ✅ Keyboard support - PicoCalc keyboard working
• ✅ RTC support - DS3231 RTC working
• ✅ Audio pinmux - Verify PWM audio pins are correctly configured
• WiFi power management - May need additional power/reset GPIO config
• ✅ Serial terminal on top USB port - Enable serial console access via upper USB-C port
• ✅ Terminal font size optimization - Adjust console font for 320x320 display

Boot Configuration

• Document Windows flashing process - I don't use windows so I can't really test this as easily
• ✅ Separate /home partition - Split /home into dedicated partition to preserve user data (resolved with overlay partition from nekocharm upstream, further enhanced here)

🧪 Testing & Validation

Hardware Testing

• ✅ WiFi scanning - Test if RTL8188FU can at least scan networks
• Power management - Test suspend/resume functionality

Build Testing

• ✅ Clean build validation - Test complete clean builds
• ✅ Overlay testing - Validate overlay overlay system
• Cross-platform testing - Test on different Linux distributions

🔌 Power Management Integration

MCU Power Management

• MCU firmware modifications - Extend MCU firmware for power management
  • Add support for detecting short button press events (vs long press that should still be handled by the MCU directly)
  • Implement power state commands (power off at least)
  • Create communication protocol for power management between MCU and Linux
  • Priority: High
• Linux power management driver - Create or extend driver for MCU power features
  • Option 1: Integrate into existing keyboard driver (same MCU device)
  • Option 2: Create separate power management driver
  • Handle button press events and translate to Linux power events
  • Implement power state control interface
  • Priority: High

📚 Documentation

User Documentation

• ✅ Flashing guide - Comprehensive FLASHING.md
• ✅ Build instructions - Clear README.md
• ✅ Package development - Detailed ADDING_PACKAGES.md
• Troubleshooting guide - Expand troubleshooting sections
• Hardware documentation - Document GPIO usage, pinout
• Setup and usage documentation - Document initial setup, package selection, user creation, wifi setup, and so on

Developer Documentation

• Device tree reference - Document custom DT bindings
• Performance optimization - Build optimization tips

🔮 Future Enhancements

Additional Hardware Support

• Support LoRA radio - use a bitbanged SPI interface on the pads below the lyra for this

Software Features

• Package manager - Add package management for runtime installs

Build System

• Multi-target support - Support for selecting different hardware variants
  • add/remove RTC from devicetree
  • add/remove Lyra SPI pins from devicetree
  • add/remove/select USB wifi driver
  • add/remove/select PWM audio driver
    • software PWM on one channel
    • hardware pwm on one channel
    • hardware pwm on two channels

🚀 Nice to Have

• Community packages - Package repository for community contributions

---

Notes

• Priority Levels: High (blocking basic functionality), Medium (usability), Low (convenience)
• Status: ✅ Complete, 🚧 In Progress, ❌ Blocked, 📝 Planning
• Contributors: Mark completed items with contributor name and date

Contributing

When working on items from this list:

1. Move item to "In Progress" section with 🚧 marker
2. Create detailed issue/PR describing the work
3. Update this file when work is completed
4. Add any new discoveries or blockers to relevant sections

For questions about specific TODO items, create an issue referencing this file.