Struct AmlogicSoC 

pub struct AmlogicSoC { /* private fields */ }

The main interface for interacting with Amlogic-based hardware

This provides low-level access to the Amlogic SoC on the Superbird device, allowing for memory operations, partition management, and firmware flashing.

Implementations

impl AmlogicSoC

pub fn init(callback: Option<Callback>) -> Result<Self>

Initialize a connection to an Amlogic SoC device

This will search for a connected device, put it in the correct mode if necessary, and establish a connection for flashing operations.

Parameters

• callback: Optional callback function to receive status updates

Returns

• Result<Self>: A connected AmlogicSoC instance or an error

pub fn write_simple_memory(&self, address: u32, data: &[u8]) -> Result<()>

Write data to device memory

This writes a small amount of data (up to 64 bytes) to device memory. For larger transfers, use write_large_memory instead.

Parameters

• address: The memory address to write to
• data: The data to write, must be <= 64 bytes

Returns

• Result<()>: Success or an error

pub fn write_memory(&self, address: u32, data: &[u8]) -> Result<()>

Write arbitrary size data to device memory

This breaks down larger transfers into multiple write_simple_memory operations.

Parameters

• address: The memory address to write to
• data: The data to write

Returns

• Result<()>: Success or an error

pub fn read_simple_memory(&self, address: u32, length: usize) -> Result<Vec<u8>>

Read a small amount of data from device memory

This reads up to 64 bytes from device memory. For larger transfers, use read_memory instead.

Parameters

• address: The memory address to read from
• length: The number of bytes to read (must be <= 64)

Returns

• Result<Vec<u8>>: The read data or an error

pub fn read_memory(&self, address: u32, length: usize) -> Result<Vec<u8>>

Read arbitrary size data from device memory

This breaks down larger transfers into multiple read_simple_memory operations.

Parameters

• address: The memory address to read from
• length: The number of bytes to read

Returns

• Result<Vec<u8>>: The read data or an error

pub fn run(&self, address: u32, keep_power: Option<bool>) -> Result<()>

Execute code at the specified memory address

Parameters

• address: The memory address to execute code from
• keep_power: Whether to keep power on after execution

Returns

• Result<()>: Success or an error

pub fn identify(&self) -> Result<String>

Identify the device

Returns

• Result<String>: The device identification string or an error

pub fn write_large_memory( &self, memory_address: u32, data: &[u8], block_length: usize, append_zeros: bool, ) -> Result<()>

Write large blocks of data to device memory

This is used for writing firmware images and other large data blocks.

Parameters

• memory_address: The memory address to write to
• data: The data to write
• block_length: The size of each block to transfer
• append_zeros: Whether to pad data with zeros to match block_length

Returns

• Result<()>: Success or an error

pub fn write_large_memory_to_disk<R: Read, F: Fn(FlashProgress)>( &self, disk_address: u32, reader: &mut R, data_size: usize, block_length: usize, append_zeros: bool, progress_callback: F, ) -> Result<()>

Write large blocks of data directly to a disk address with progress tracking

Parameters

• disk_address: The disk address to write to
• reader: A reader providing the data to write
• data_size: The total size of data to write
• block_length: The size of each block to transfer
• append_zeros: Whether to pad data with zeros to match block_length
• progress_callback: Function to call with progress updates

Returns

• Result<()>: Success or an error

pub fn write_amlc_data(&self, offset: u32, data: &[u8]) -> Result<()>

pub fn write_amlc_data_packet( &self, seq: u8, amlc_offset: u32, data: &[u8], ) -> Result<()>

pub fn get_boot_amlc(&self) -> Result<(u32, u32)>

pub fn bl2_boot( &self, bl2: Option<&[u8]>, bootloader: Option<&[u8]>, ) -> Result<()>

Execute the BL2 boot sequence

This boots the device using the specified BL2 and bootloader binaries.

Parameters

• bl2: Optional BL2 binary data (uses built-in if None)
• bootloader: Optional bootloader binary data (uses built-in if None)

Returns

• Result<()>: Success or an error

pub fn bulkcmd(&self, command: &str) -> Result<String>

Send a bulk command to the device

Parameters

• command: The command string to send

Returns

• Result<String>: The command response or an error

pub fn validate_partition_size( &self, part_name: &str, part_info: &PartitionInfo, ) -> Result<usize>

Validate the size of a partition

Parameters

• part_name: The name of the partition
• part_info: Partition information

Returns

• Result<usize>: The validated partition size or an error

pub fn restore_partition<R: Read, F: Fn(FlashProgress)>( &self, part_name: &str, part_size: usize, reader: R, file_size: usize, progress_callback: F, ) -> Result<()>

Restore a partition from a data source

Parameters

• part_name: The name of the partition to restore
• part_size: The size of the partition
• reader: A reader providing the partition data
• file_size: The size of the data being read
• progress_callback: Function to call with progress updates

Returns

• Result<()>: Success or an error

pub fn unbrick(&self) -> Result<()>

Execute the unbrick procedure

This writes the emergency unbrick image to the device.

Returns

• Result<()>: Success or an error

pub fn host_setup() -> Result<()>

Set up the host environment for USB access

On Linux, this creates udev rules to allow access to the device.

Returns

• Result<()>: Success or an error

Trait Implementations

impl Clone for AmlogicSoC

fn clone(&self) -> AmlogicSoC

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Drop for AmlogicSoC

fn drop(&mut self)

Executes the destructor for this type.