System library overview

Table of Contents

• Introduction
• Key Features
• Architecture
• Main Components
  • Display Control
  • Button Backlight control
  • Buzzer Control
  • Bootloader Operations
  • System Information
  • OTP Register Access
    • Common OTP Register Addresses

Introduction

The D7 SDK System Library provides interfaces for controlling various hardware components of the Veethree D7 platform including display backlight, button illumination, buzzer, bootloader environment variables retrieval, and OTP register access.

Key Features

• Display backlight control with brightness adjustment
• Button illumination control with individual and group control
• Buzzer control for audible feedback
• Set and get operations of the bootloader environment variables
• System information retrieval
• OTP register read operations

Architecture

The System Library is organized into several key components:

• Display - Control of the display backlight and properties
• Buttons - Control of button illumination
• Buzzer - Control of the system buzzer
• Bootloader - Interface for bootloader operations
• System Info - Functions to retrieve system information
• OTP - One-Time Programmable register access for device configuration

Main Components

Display Control

The Display component provides interfaces for controlling the display backlight and properties.

Key class:

• vsdk::sys::backlight_manager - Main class for display operations

#include <system/display_backlight.h>
void example() {
    using namespace vsdk::sys;
 
    // Set the backlight brightness (0-100%)
    backlight_manager::set_brightness(75);
}

Button Backlight control

The Button Backlight control provides interfaces for controlling the button LEDs.

Key class:

• vsdk::sys::rgb_button_backlight - Main class for button illumination operations

#include <system/button_backlight.h>
 
void example() {
    using namespace vsdk::sys;
    rgb_button_backlight(rgb_button_id::btn1).set_colour(200, 10, 0);
}

Buzzer Control

The Buzzer component provides interfaces for generating audible feedback.

Key class:

• vsdk::sys::buzzer - Main singleton for buzzer operations

#include <system/buzzer.h>
void example() {
    using namespace vsdk::sys;
    // Enable the buzzer
    buzzer::buzzer_enable(true);
    // Wait for 500ms
    std::this_thread::sleep_for(500ms);
    // Disable the buzzer
    buzzer::buzzer_enable(false);
}

Bootloader Operations

The bootloader component is responsible for interacting with the board bootloader, primarily via bootloader environment variables.

Key class:

• vsdk::sys::bootloader_manager - Main class for bootloader operations

#include <system/bootloader_manager.h>
 
void example() {
    using namespace vsdk::sys;
    // Set a bootloader variable value
    bootloader_manager::set_value("brightness_level", 75);
    // Get a bootloader variable value
    std::string brightness_level{};
    bootloader_manager::get_value("brightness_level", brightness_level);
}

System Information

The System Information component provides interfaces for retrieving system information.

Key classes:

• vsdk::sys::board_info - Main class for system information operations

#include <system/board_info.h>
void example() {
    using namespace vsdk::sys;
    // Get the system information instance
    auto const sn = vsdk::sys::board_info::soc_serial_number();
}

OTP Register Access

The OTP (One-Time Programmable) component provides interfaces for reading permanent device configuration data, and factory-programmed information from OTP registers.

Key class:

• vsdk::sys::otp_manager - Main class for OTP register operations

#include <system/otp_manager.h>
 
void read_device_info() {
    using namespace vsdk::sys;
    
    // Read device serial number or calibration data
    std::vector<uint32_t> data;
    auto result = otp_manager::read(0x2c4, 4, data); 
    
    if (result == otp_result::success) {
        // Process the OTP data
        for (size_t i = 0; i < data.size(); i++) {
            // Handle each 32-bit word
        }
    }
}

Common OTP Register Addresses

Fuse Row Index	Purpose
708-709	MAC Address 1
710-711	MAC Address 2
765-766	Device Information

Please refer to the i.MX8QXP Reference Manual, Chapter 7 (Fuse Map) for complete fuse row specifications.

See the System library examples page for complete code examples.