import"sbIDeviceFirmwareHandler.idl";

Inheritance diagram for sbIDeviceFirmwareHandler:

Collaboration diagram for sbIDeviceFirmwareHandler:

Public Member Functions
boolean	canUpdate (in sbIDevice aDevice, in unsigned long aDeviceVendorID, in unsigned long aDeviceProductID)
	Check to see if this handler can update the specified device. More...

void	initiateRecoveryModeSwitch ([optional] in unsigned long aDeviceVendorID, [optional] in unsigned long aDeviceProductID)
	Notify the handler to expect a device to connect in recovery mode. More...

void	bind (in sbIDevice aDevice, in sbIDeviceEventListener aListener)
	Bind the handler to a device. More...

boolean	rebind (in sbIDevice aDevice, in sbIDeviceEventListener aListener)
	Rebind a device to an already running handler. More...

void	unbind ()
	Unbind the handler. More...

void	cancel ()
	Cancel the current operation. More...

void	refreshInfo ()
	Refresh the firmware location, version, readable version, notes, and instructions. More...

void	update (in sbIDeviceFirmwareUpdate aFirmwareUpdate)
	Perform a firmware update on the specified device. More...

void	recover (in sbIDeviceFirmwareUpdate aFirmwareUpdate)
	Perform a recovery update on the specified device. More...

void	verifyDevice ()
	Verify the firmware already on the device. More...

void	verifyUpdate (in sbIDeviceFirmwareUpdate aFirmwareUpdate)
	Verify the firmware update image. More...

Public Attributes
readonly attribute AString	contractId
	The Contract ID for this handler. More...

readonly attribute nsIURI	latestFirmwareLocation
	URI for latest firmware (where it can be downloaded from). More...

readonly attribute unsigned long	latestFirmwareVersion
	The latest firmware version, in machine friendly format. More...

readonly attribute AString	latestFirmwareReadableVersion
	The latest firmware version, in human readable format. More...

readonly attribute unsigned long	currentFirmwareVersion
	The current firmware version, in machine friendly format. More...

readonly attribute AString	currentFirmwareReadableVersion
	The current firmware version on the device, in human readable format (eg. xx.xx.xx.xx). More...

readonly attribute nsIURI	releaseNotesLocation
	Location for the release notes of the latest firmware. More...

readonly attribute nsIURI	resetInstructionsLocation
	Location of the reset instructions. More...

readonly attribute AString	recoveryModeKeyCombination
	Magic key combination required by the device to go into recovery or firmware flashing mode. More...

readonly attribute nsIURI	customerSupportLocation
	Device Customer Support URL. More...

readonly attribute nsIURI	registerLocation
	Location where one can perform owner registration with the device manufacturer. More...

readonly attribute boolean	needsRecoveryMode
	Whether the device needs to be in recovery mode to have its firmware updated. More...

readonly attribute boolean	recoveryMode
	Indicates whether the device is in recovery mode or not. More...

readonly attribute sbIDeviceFirmwareUpdate	defaultFirmwareUpdate
	The default firmware update that is packaged with the firmware handler. This update should always be available. More...

readonly attribute sbIDevice	boundDevice
	The device bound to this handler, or null. More...

readonly attribute AString	deviceModelNumber
	Device model number / name as reported by the firmware handler. More...

readonly attribute AString	deviceModelVersion
	Device model version / version name as reported by the firmware handler. More...

readonly attribute AString	deviceVendor
	Device manufacturer as reported by the firmware handler. More...

readonly attribute nsISimpleEnumerator	supportedDevices
	Array containing the list of devices supported by the firmware handler. More...

Detailed Description

Note: Implementations of this interface must be threadsafe.; The methods which take an sbIDeviceEventListener will also send events to the registered device listeners. You only need to use your own listener if you do not have a listener registered with the device.

Definition at line 42 of file sbIDeviceFirmwareHandler.idl.

Member Function Documentation

void sbIDeviceFirmwareHandler::bind	(	in sbIDevice	aDevice,
		in sbIDeviceEventListener	aListener
	)

Bind the handler to a device.

Parameters

aDevice	- The device you wish to bind to
[optional]	aListener - Optional event listener to also send events to, may be null.

Warning: This can only be called once, all subsequent calls to this method will return NS_ERROR_ALREADY_INITIALIZED.

Exceptions

NS_ERROR_ALREADY_INITIALIZED when handler is already bound.

void sbIDeviceFirmwareHandler::cancel ( )

Cancel the current operation.

boolean sbIDeviceFirmwareHandler::canUpdate	(	in sbIDevice	aDevice,
		in unsigned long	aDeviceVendorID,
		in unsigned long	aDeviceProductID
	)

Check to see if this handler can update the specified device.

Parameters

aDevice	- The device
aDeviceVendorID	[optional] - The device vendor ID. Set to 0 if not available.
aDeviceProductID	[optional] - The device product ID. Set to 0 if not available.

Note: No events need to be sent for this method. It should be a synchronous operation. But, do try and be as quick about it as possible.

void sbIDeviceFirmwareHandler::initiateRecoveryModeSwitch	(	[optional] in unsigned long	aDeviceVendorID,
		[optional] in unsigned long	aDeviceProductID
	)

Notify the handler to expect a device to connect in recovery mode.

Parameters

aDeviceVendorID	- The device vendor ID of the device that will reconnect in recovery mode, or 0 for the currently bound device.
aDeviceProductID	- The device product ID of the device that will reconnect in recovery mode, or 0 for the currently bound device.

Note: No events need to be sent for this method. It should be a synchronous operation. But, do try and be as quick about it as possible.

boolean sbIDeviceFirmwareHandler::rebind	(	in sbIDevice	aDevice,
		in sbIDeviceEventListener	aListener
	)

Rebind a device to an already running handler.

Parameters

aDevice	- The device you wish to bind to
[optional]	aListener - Optional event listener to also send events to, may be null.

Note: Rebind is meant to be used when a device switches modes but must continue an existing firmware update (eg. switching to recovery mode).

Return values

PR_TRUE	Rebinding was successful
PR_FALSE	Rebinding failed

void sbIDeviceFirmwareHandler::recover ( in sbIDeviceFirmwareUpdate aFirmwareUpdate )

Perform a recovery update on the specified device.

Note: Calling this method will often wipe all content from the device

Parameters

aFirmwareUpdate - The firmware update to apply during the recovery update.

void sbIDeviceFirmwareHandler::refreshInfo ( )

Refresh the firmware location, version, readable version, notes, and instructions.

void sbIDeviceFirmwareHandler::unbind ( )

Unbind the handler.

void sbIDeviceFirmwareHandler::update ( in sbIDeviceFirmwareUpdate aFirmwareUpdate )

Perform a firmware update on the specified device.

Parameters

aFirmwareUpdate - The firmware update to apply

void sbIDeviceFirmwareHandler::verifyDevice ( )

Verify the firmware already on the device.

void sbIDeviceFirmwareHandler::verifyUpdate ( in sbIDeviceFirmwareUpdate aFirmwareUpdate )

Verify the firmware update image.

Parameters

aFirmwareUpdate - The firmware update to verify

Member Data Documentation

readonly attribute sbIDevice sbIDeviceFirmwareHandler::boundDevice

The device bound to this handler, or null.

Definition at line 147 of file sbIDeviceFirmwareHandler.idl.

readonly attribute AString sbIDeviceFirmwareHandler::contractId

The Contract ID for this handler.

Definition at line 47 of file sbIDeviceFirmwareHandler.idl.

readonly attribute AString sbIDeviceFirmwareHandler::currentFirmwareReadableVersion

The current firmware version on the device, in human readable format (eg. xx.xx.xx.xx).

Note: The handler must be bound to a device for this value to be valid.

Definition at line 82 of file sbIDeviceFirmwareHandler.idl.

readonly attribute unsigned long sbIDeviceFirmwareHandler::currentFirmwareVersion

The current firmware version, in machine friendly format.

Note: The handler must be bound to a device for this value to be valid.

Definition at line 75 of file sbIDeviceFirmwareHandler.idl.

readonly attribute nsIURI sbIDeviceFirmwareHandler::customerSupportLocation

Device Customer Support URL.

Note: This value is not valid until is is refreshed at least once. The value can be refreshed by calling refreshInfo.

Definition at line 113 of file sbIDeviceFirmwareHandler.idl.

readonly attribute sbIDeviceFirmwareUpdate sbIDeviceFirmwareHandler::defaultFirmwareUpdate

The default firmware update that is packaged with the firmware handler. This update should always be available.

Definition at line 142 of file sbIDeviceFirmwareHandler.idl.

readonly attribute AString sbIDeviceFirmwareHandler::deviceModelNumber

Device model number / name as reported by the firmware handler.

Note: This is optional and may be null.

Definition at line 153 of file sbIDeviceFirmwareHandler.idl.

readonly attribute AString sbIDeviceFirmwareHandler::deviceModelVersion

Device model version / version name as reported by the firmware handler.

Note: This is optional and may be null.

Definition at line 160 of file sbIDeviceFirmwareHandler.idl.

readonly attribute AString sbIDeviceFirmwareHandler::deviceVendor

Device manufacturer as reported by the firmware handler.

Note: This is optional and may be null.

Definition at line 166 of file sbIDeviceFirmwareHandler.idl.

readonly attribute nsIURI sbIDeviceFirmwareHandler::latestFirmwareLocation

URI for latest firmware (where it can be downloaded from).

Note: This value is not valid until it is refreshed at least once. The value can be refreshed by calling refreshInfo.

Definition at line 54 of file sbIDeviceFirmwareHandler.idl.

readonly attribute AString sbIDeviceFirmwareHandler::latestFirmwareReadableVersion

The latest firmware version, in human readable format.

Note: This value is not valid until it is refreshed at least once. The value can be refreshed by calling refreshInfo.

Definition at line 68 of file sbIDeviceFirmwareHandler.idl.

readonly attribute unsigned long sbIDeviceFirmwareHandler::latestFirmwareVersion

The latest firmware version, in machine friendly format.

Note: This value is not valid until it is refreshed at least once. The value can be refreshed by calling refreshInfo.

Definition at line 61 of file sbIDeviceFirmwareHandler.idl.

readonly attribute boolean sbIDeviceFirmwareHandler::needsRecoveryMode

Whether the device needs to be in recovery mode to have its firmware updated.

Note: This value is not valid until it is refreshed at least once. The value can be refreshed by calling refreshInfo.

Definition at line 129 of file sbIDeviceFirmwareHandler.idl.

readonly attribute boolean sbIDeviceFirmwareHandler::recoveryMode

Indicates whether the device is in recovery mode or not.

Note: This value is not valid until it is refreshed at least once. The value can be refreshed by calling refreshInfo.

Definition at line 136 of file sbIDeviceFirmwareHandler.idl.

readonly attribute AString sbIDeviceFirmwareHandler::recoveryModeKeyCombination

Magic key combination required by the device to go into recovery or firmware flashing mode.

Note: This value is not valid until it is refreshed at least once. This value can be refreshed by calling refreshInfo.; This is optional and may be null.

Definition at line 106 of file sbIDeviceFirmwareHandler.idl.

readonly attribute nsIURI sbIDeviceFirmwareHandler::registerLocation

Location where one can perform owner registration with the device manufacturer.

Note: This value is not valid until it is refreshed at least once. The value can be refreshed by calling refreshInfo.

Definition at line 121 of file sbIDeviceFirmwareHandler.idl.

readonly attribute nsIURI sbIDeviceFirmwareHandler::releaseNotesLocation

Location for the release notes of the latest firmware.

Note: This value is not valid until it is refreshed at least once. The value can be refreshed by calling refreshInfo.

Definition at line 89 of file sbIDeviceFirmwareHandler.idl.

readonly attribute nsIURI sbIDeviceFirmwareHandler::resetInstructionsLocation

Location of the reset instructions.

Note: This value is not valid until it is refreshed at least once. The value can be refreshed by calling refreshInfo.; This is optional and may be null.

Definition at line 97 of file sbIDeviceFirmwareHandler.idl.

readonly attribute nsISimpleEnumerator sbIDeviceFirmwareHandler::supportedDevices

Array containing the list of devices supported by the firmware handler.

Note: This is optional and may be null.; Array contains sbIDeviceFirmwareSupport objects

Definition at line 174 of file sbIDeviceFirmwareHandler.idl.

The documentation for this interface was generated from the following file:

/home/martin/dev/nightingale-hacking/components/devices/base/public/sbIDeviceFirmwareHandler.idl

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

Member Data Documentation