PlatformDriver

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

Extends

• DeviceDriver<PlatformDevice>

Constructors

Constructor

new PlatformDriver(init): PlatformDriver

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

Parameters

init

PlatformDriverInit

Returns

PlatformDriver

Overrides

DeviceDriver.constructor

Properties

attrs

readonly attrs: Record<string, DriverAttribute>

Defined in: src/drivers/base/driver.ts:64

Inherited from

DeviceDriver.attrs

---

bus

readonly bus: BusType

Defined in: src/drivers/base/driver.ts:45

Inherited from

DeviceDriver.bus

---

dev_attrs

readonly dev_attrs: Record<string, DeviceAttribute>

Defined in: src/drivers/base/driver.ts:65

Inherited from

DeviceDriver.dev_attrs

---

disableSysfsBind?

optional disableSysfsBind?: boolean

Defined in: src/drivers/base/driver.ts:59

Don’t add the bind and unbind attributes

Inherited from

DeviceDriver.disableSysfsBind

---

driver_managed_dma?

optional driver_managed_dma?: boolean

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

---

id_table?

optional id_table?: PlatformDeviceId[]

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

---

kobject?

optional kobject?: KObject

Defined in: src/drivers/base/driver.ts:56

Internal

/sys/bus/<bus>/drivers/<name>, set by register.

Inherited from

DeviceDriver.kobject

---

mod_name?

readonly optional mod_name?: string

Defined in: src/drivers/base/driver.ts:50

Used for built-in modules

Inherited from

DeviceDriver.mod_name

---

name

readonly name: string

Defined in: src/drivers/base/driver.ts:44

Inherited from

DeviceDriver.name

---

of_match_table?

readonly optional of_match_table?: readonly "xterm"[]

Defined in: src/drivers/base/driver.ts:62

The device tree node kinds this driver handles, i.e. driver->of_match_table

Inherited from

DeviceDriver.of_match_table

---

owner?

optional owner?: Module

Defined in: src/drivers/base/driver.ts:48

The module this driver is part of. Built-in drivers don’t have one.

Inherited from

DeviceDriver.owner

---

prevent_deferred_probe?

optional prevent_deferred_probe?: boolean

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

Accessors

link_name

Get Signature

get protected link_name(): string

Defined in: src/drivers/base/driver.ts:104

The name this driver is linked as in /sys/module/<module>/drivers.

Returns

string

Inherited from

DeviceDriver.link_name

---

module

Get Signature

get protected module(): Module | null

Defined in: src/drivers/base/driver.ts:111

The module this driver belongs to, which is either the one it was registered with or the built-in one named by mod_name.

Returns

Module | null

Inherited from

DeviceDriver.module

Methods

attach()

attach(): void

Defined in: src/drivers/base/driver.ts:167

Offer every unbound device on the bus to this driver.

Returns

void

Inherited from

DeviceDriver.attach

---

bind()

bind(name): void

Defined in: src/drivers/base/driver.ts:179

Bind the device named name to this driver. Backs the bind attribute.

Parameters

name

string

Returns

void

Throws

ENODEV if there is no such device on the bus, or the bus doesn’t match it

Throws

EBUSY if the device already has a driver

Inherited from

DeviceDriver.bind

---

matches()

matches(device): boolean

Defined in: src/drivers/base/driver.ts:96

Whether this driver can handle device, according to the bus they share. A bus without a match accepts every device on it, like Linux.

Parameters

device

Device

Returns

boolean

Inherited from

DeviceDriver.matches

---

probe()?

optional probe(device): boolean

Defined in: src/drivers/base/driver.ts:82

Parameters

device

PlatformDevice

Returns

boolean

Inherited from

DeviceDriver.probe

---

register()

register(): void

Defined in: src/drivers/base/driver.ts:120

Add the driver to its bus, creating /sys/bus/<bus>/drivers/<name>, then offer it every unbound device on the bus.

Returns

void

Throws

EEXIST if the driver is already registered, or the bus already has one by that name

Inherited from

DeviceDriver.register

---

remove()?

optional remove(device): void

Defined in: src/drivers/base/driver.ts:84

Parameters

device

PlatformDevice

Returns

void

Inherited from

DeviceDriver.remove

---

resume()?

optional resume(device): void

Defined in: src/drivers/base/driver.ts:88

Parameters

device

PlatformDevice

Returns

void

Inherited from

DeviceDriver.resume

---

shutdown()?

optional shutdown(device): void

Defined in: src/drivers/base/driver.ts:85

Parameters

device

PlatformDevice

Returns

void

Inherited from

DeviceDriver.shutdown

---

suspend()?

optional suspend(device): void

Defined in: src/drivers/base/driver.ts:87

Parameters

device

PlatformDevice

Returns

void

Inherited from

DeviceDriver.suspend

---

unbind()

unbind(name): void

Defined in: src/drivers/base/driver.ts:191

Unbind the device named name from this driver. Backs the unbind attribute.

Parameters

name

string

Returns

void

Throws

ENODEV if there is no such device on the bus, or it isn’t bound to this driver

Inherited from

DeviceDriver.unbind

---

unregister()

unregister(): void

Defined in: src/drivers/base/driver.ts:147

Undo register, unbinding every device the driver is bound to

Returns

void

Inherited from

DeviceDriver.unregister