FelDevice | fel

Class to represent a connected USB device in FEL mode.

Hierarchy

FelDevice

Index

Modules

ProgressCallback

Constructors

constructor

Properties

isOpen

Constructors

constructor

new FelDevice(device: Device, iface: Interface, inEndpoint: InEndpoint, outEndpoint: OutEndpoint): FelDevice

- Defined in FelDevice.ts:44
Constructs a new FEL device.

Parameters
- device: Device
- iface: Interface
- inEndpoint: InEndpoint
- outEndpoint: OutEndpoint
Returns FelDevice

Properties

isOpen

isOpen: boolean = false

If the device is open

Methods

close

close(force?: boolean): Promise<void>

- Defined in FelDevice.ts:82
Closes the FEL device

Parameters
- Default value force: boolean = false
Returns Promise<void>

execute

execute(address: number): Promise<void>

- Defined in FelDevice.ts:466
Executes the code at the given address.

Parameters
- address: number
  
  The address to jump to.
Returns Promise<void>

felRead

felRead(length: number): Promise<Buffer>

- Defined in FelDevice.ts:166
Reads data from the FEL device.

Parameters
- length: number
  
  length The length of data to read.
Returns Promise<Buffer>

A Buffer of the given length containing data from the FEL device.

felRequest

felRequest(command: RequestType, address?: undefined | number, length?: undefined | number): Promise<void>

- Defined in FelDevice.ts:189
Send a FEL request to the device

Parameters
- command: RequestType
  
  The command to send
- Optional address: undefined | number
  
  The address to set on the command
- Optional length: undefined | number
  
  The length to set on the command
Returns Promise<void>

felWrite

felWrite(buffer: Buffer): Promise<void>

- Defined in FelDevice.ts:147
Writes data to the FEL device.

Parameters
- buffer: Buffer
Returns Promise<void>

getFes1Bin

getFes1Bin(): Buffer

- Defined in FelDevice.ts:480
Gets the FES1 binary data.

Returns Buffer

The FES1 binary data

getUbootBin

getUbootBin(): Buffer

- Defined in FelDevice.ts:496
Gets the uboot binary data

Returns Buffer

The uboot binary data

initializeDRAM

initializeDRAM(): Promise<boolean>

- Defined in FelDevice.ts:205
Initializes the system DRAM once fes1 and uboot have been loaded.

Returns Promise<boolean>

Whether or not the DRAM was initialized

isFes1Loaded

isFes1Loaded(): boolean

- Defined in FelDevice.ts:120
Returns boolean

isUbootLoaded

isUbootLoaded(): boolean

- Defined in FelDevice.ts:116
Returns boolean

loadFes1

loadFes1(fes1Path: string): void

- Defined in FelDevice.ts:107
Loads the fes1 into memory.

Parameters
- fes1Path: string
Returns void

loadUboot

loadUboot(ubootPath: string): Promise<void>

- Defined in FelDevice.ts:94
Loads the uboot into memory.

Parameters
- ubootPath: string
Returns Promise<void>

open

open(force?: boolean): Promise<void>

- Defined in FelDevice.ts:63
Opens the FEL device. When you are finished communicating with the device, you should call the close() method.

Parameters
- Default value force: boolean = false
Returns Promise<void>

readDeviceFlash

readDeviceFlash(address: number, length: number, progressCallback?: ProgressCallback): Promise<Buffer>

- Defined in FelDevice.ts:368
Reads froms the device NAND

Parameters
- address: number
- length: number
- Optional progressCallback: ProgressCallback
Returns Promise<Buffer>

readDeviceMemory

readDeviceMemory(address: number, length: number, progressCallback?: ProgressCallback): Promise<Buffer>

- Defined in FelDevice.ts:292
Read data directly from the FEL device's memory.

Parameters
- address: number
  
  The address to read from
- length: number
  
  The length of data to read
- Optional progressCallback: ProgressCallback
Returns Promise<Buffer>

A Buffer representing the data at the given address of the given length

readFromUSB

readFromUSB(length: number): Promise<Buffer>

- Defined in FelDevice.ts:137
Reads data directly from the USB interface.

Parameters
- length: number
  
  The amount of bytes to read
Returns Promise<Buffer>

runUbootCommand

runUbootCommand(command: string, noReturn: boolean, progressCallback?: ProgressCallback): Promise<void>

- Defined in FelDevice.ts:405
Runs the given uboot command

Parameters
- command: string
  
  The uboot command to run
- noReturn: boolean
  
  Whether or not to check for FEL connectivity afterward
- Optional progressCallback: ProgressCallback
Returns Promise<void>

setFes1Bin

setFes1Bin(fes1Bin: Buffer): void

- Defined in FelDevice.ts:488
Sets the FES1 binary data

Parameters
- fes1Bin: Buffer
  
  The FES1 binary data
Returns void

setUbootBin

setUbootBin(ubootBin: Buffer): void

- Defined in FelDevice.ts:504
Sets the uboot binary data

Parameters
- ubootBin: Buffer
  
  The uboot binary data
Returns void

verifyDevice

verifyDevice(): Promise<AwVerifyDeviceResponse>

- Defined in FelDevice.ts:233
Returns Promise<AwVerifyDeviceResponse>

writeDeviceFlash

writeDeviceFlash(address: number, buffer: Buffer, progressCallback?: ProgressCallback): Promise<void>

- Defined in FelDevice.ts:330
Writes to the device NAND

Parameters
- address: number
- buffer: Buffer
- Optional progressCallback: ProgressCallback
Returns Promise<void>

writeDeviceMemory

writeDeviceMemory(address: number, buffer: Buffer, progressCallback?: ProgressCallback): Promise<void>

- Defined in FelDevice.ts:252
Writes data directly to the FEL device's memory.

Parameters
- address: number
  
  The address to write to
- buffer: Buffer
  
  The data to write to memory
- Optional progressCallback: ProgressCallback
Returns Promise<void>

writeToUSB

writeToUSB(buffer: Buffer): Promise<void>

- Defined in FelDevice.ts:128
Sends data directly to the USB interface for the FEL device

Parameters
- buffer: Buffer
Returns Promise<void>

Generated using TypeDoc