PlatformDevice

Defined in: src/drivers/base/platform.ts:13

Extends

• Device

Properties

attrs

attrs: Record<string, DeviceAttribute> = {}

Defined in: src/device.ts:151

Inherited from

CPU.attrs

---

bus?

optional bus?: BusType<Device<unknown>, DeviceDriver<Device<unknown>>>

Defined in: src/device.ts:128

Inherited from

Device.bus

---

class?

optional class?: Class

Defined in: src/device.ts:131

Inherited from

Device.class

---

dev_t?

optional dev_t?: DevT

Defined in: src/device.ts:134

The device number. Devices with one get a dev attribute and a link in /sys/dev.

Inherited from

Device.dev_t

---

driver

driver: PlatformDriver

Defined in: src/drivers/base/platform.ts:14

Overrides

Device.driver

---

driver_data?

optional driver_data?: unknown

Defined in: src/device.ts:140

Whatever the bound driver wants to keep with the device, i.e. dev->driver_data

Inherited from

Device.driver_data

---

driver_override?

optional driver_override?: string

Defined in: src/drivers/base/platform.ts:26

Internal

Driver name to force a match.

---

id

id: number

Defined in: src/drivers/base/platform.ts:18

Overrides

Device.id

---

id_entry

id_entry: PlatformDeviceId

Defined in: src/drivers/base/platform.ts:21

---

idAuto

idAuto: boolean

Defined in: src/drivers/base/platform.ts:19

---

kobj_parent?

optional kobj_parent?: KObject

Defined in: src/device.ts:146

Forces where the device goes in sysfs, like setting dev->kobj.parent before register. This is how a bus’ root device ends up somewhere like /sys/devices/system.

Inherited from

Device.kobj_parent

---

kobject?

optional kobject?: DeviceKObject

Defined in: src/device.ts:149

/sys/devices/.../<name>. Only set while the device is registered.

Inherited from

CPU.kobject

---

name

readonly name: string

Defined in: src/drivers/base/platform.ts:17

Overrides

Device.name

---

of_node?

optional of_node?: object & object

Defined in: src/device.ts:137

The device tree node this device was created from, i.e. dev->of_node

Type Declaration

id?

optional id?: string

What the device is called under /sys/devices/platform. One is made up when there isn’t one.

kind

kind: "xterm"

Type Declaration

options?

optional options?: AttachXTermOptions

terminal

terminal: XTermLike

Inherited from

Device.of_node

---

parent

parent: PlatformDevice | null

Defined in: src/drivers/base/platform.ts:15

Overrides

Device.parent

---

power

power: Partial<DevicePowerInfo> = {}

Defined in: src/device.ts:153

Inherited from

CPU.power

---

removable?

optional removable?: "unknown" | "removable" | "fixed"

Defined in: src/device.ts:155

Inherited from

CPU.removable

---

resources

resources: Resource[]

Defined in: src/drivers/base/platform.ts:20

---

type?

optional type?: DeviceType

Defined in: src/device.ts:130

Inherited from

Device.type

Accessors

path

Get Signature

get path(): string | undefined

Defined in: src/device.ts:171

The device’s path relative to the root of sysfs, if it is registered

Returns

string | undefined

Inherited from

Device.path

---

registered

Get Signature

get registered(): boolean

Defined in: src/device.ts:166

Whether the device is currently in sysfs

Returns

boolean

Inherited from

Device.registered

Methods

attach()

attach(): boolean

Defined in: src/device.ts:212

Look for a driver on the device’s bus that can handle it.

Returns

boolean

whether the device ended up bound

Inherited from

Device.attach

---

bind_driver()

bind_driver(drv): void

Defined in: src/device.ts:255

Bind a device to a driver without probing it.

Parameters

drv

DeviceDriver

Returns

void

Throws

EBUSY if the device is already bound

Inherited from

Device.bind_driver

---

dev_node()

dev_node(): object

Defined in: src/device.ts:356

Internal

Work out the name and mode a device’s node under /dev should have.

Returns

object

a mode of 0 when nothing set one

mode

mode: number

name

name: string

Inherited from

Device.dev_node

---

link_driver()

protected link_driver(): void

Defined in: src/device.ts:197

Link the device up with the driver it just bound to.

Returns

void

Inherited from

Device.link_driver

---

register()

register(): void

Defined in: src/device.ts:284

Add a device to sysfs, link it up with its bus and class, then try to find it a driver.

Returns

void

Throws

EEXIST if the device is already registered, or something else has its name

Inherited from

Device.register

---

release_driver()

release_driver(): void

Defined in: src/device.ts:265

Unbind a device from its driver. Does nothing if it isn’t bound.

Returns

void

Inherited from

Device.release_driver

---

sysfs_parent()

protected sysfs_parent(): KObject

Defined in: src/device.ts:178

Work out where a device goes in sysfs.

Returns

KObject

Inherited from

Device.sysfs_parent

---

try_bind()

try_bind(drv): boolean

Defined in: src/device.ts:234

Offer the device to a driver, binding the two if the driver’s probe accepts it. A driver without a probe takes every device the bus matched for it.

Parameters

drv

DeviceDriver

Returns

boolean

whether the device was bound

Inherited from

Device.try_bind

---

unregister()

unregister(): void

Defined in: src/device.ts:327

Remove a device from sysfs, unbinding it from its driver first. Does nothing if the device isn’t registered.

Returns

void

Inherited from

Device.unregister