通訊協定
偵錯
定義於 fuchsia.hardware.spmi/spmi.fidl
ConnectTarget
使用指定 ID 連線至目標裝置。等同於透過對應的驅動程式庫節點連線至 TargetService。
如果 target_id 大於或等於 MAX_TARGETS,則傳回 INVALID_ARGS。如果匯流排上沒有這類目標,可能會傳回錯誤;否則,嘗試存取用戶端時會傳回錯誤。
要求
| 名稱 | 類型 |
|---|---|
target_id |
uint8
|
server |
server_end:Device
|
回應
| 名稱 | 類型 |
|---|---|
payload |
Debug_ConnectTarget_Result
|
GetControllerProperties
傳回主機 SPMI 控制器的屬性。
要求
<EMPTY>
回應
| 名稱 | 類型 |
|---|---|
payload |
DebugGetControllerPropertiesResponse
|
裝置
定義於 fuchsia.hardware.spmi/spmi.fidl
每個 Device 執行個體都代表 SPMI 匯流排上的目標/次要 SPMI 裝置。如要支援多個 SPMI 裝置,必須例項化多個節點。
CancelWatchControllerWriteCommands
取消對 WatchControllerWriteCommands 的待處理呼叫。address 和 size 必須與先前對 WatchControllerWriteCommands() 的呼叫完全相符,否則會傳回 NOT_FOUND。
要求
| 名稱 | 類型 |
|---|---|
address |
uint8
|
size |
uint16
|
回應
| 名稱 | 類型 |
|---|---|
payload |
Device_CancelWatchControllerWriteCommands_Result
|
GetProperties
取得 SPMI 裝置的屬性。
要求
<EMPTY>
回應
| 名稱 | 類型 |
|---|---|
payload |
Device_GetProperties_Result
|
RegisterRead
向 SPMI 裝置發出暫存器讀取指令。實作時可選擇要使用的 SPMI 變化版本 (例如擴充、長)。如果成功,則會從裝置中的 address 開始,在 data 中連續讀取並傳回 size_bytes。
要求
| 名稱 | 類型 |
|---|---|
address |
uint16
|
size_bytes |
uint32
|
回應
| 名稱 | 類型 |
|---|---|
payload |
Device_RegisterRead_Result
|
RegisterWrite
向 SPMI 裝置發出暫存器寫入指令。實作時可選擇要使用的 SPMI 變化版本 (例如擴充、長)。如果這個指令成功,系統會從裝置中的 address 開始連續寫入 data。
要求
| 名稱 | 類型 |
|---|---|
address |
uint16
|
data |
vector<uint8>
|
回應
| 名稱 | 類型 |
|---|---|
payload |
Device_RegisterWrite_Result
|
WatchControllerWriteCommands
Hanging-get 方法,用於接收來自裝置的控制器寫入指令。address 和 size 指定要監控指令的暫存器範圍。不允許多次重疊呼叫這個方法。如果 address 或 size 無效,則傳回 INVALID_ARGS;如果這個暫存器範圍有其他呼叫待處理,則傳回 BAD_STATE。如果為這個暫存器範圍呼叫 CancelWatchControllerWriteCommands(),則傳回 CANCELED。
如果這個方法是為了在設定手錶時讓系統保持喚醒狀態 (防止暫停),請使用傳入的 setup_wake_lease LeaseToken。接著,當手錶觸發時,這個方法會傳回第二個 wake_lease LeaseToken,防止暫停。
這些保持運作喚醒租約權杖是由 Power Framework 的系統活動管理工具提供。支援 Keep-Alive 的驅動程式必須能從系統活動管理工具取得 wake_lease。
關閉 wake_lease 時,系統會捨棄建立的喚醒租約,防止系統在手錶觸發時暫停。因此,為確保系統不會遭到 Power Framework 暫停,用戶端必須在系統需要保持喚醒狀態時保留此 wake_lease,或在捨棄 wake_lease 之前從 Power Framework 取得自己的喚醒租約,以防止暫停。
要求
| 名稱 | 類型 |
|---|---|
address |
uint8
|
size |
uint16
|
setup_wake_lease |
fuchsia.power.system/LeaseToken
|
回應
| 名稱 | 類型 |
|---|---|
payload |
Device_WatchControllerWriteCommands_Result
|
STRUCTS
Debug_ConnectTarget_Response
定義於 fuchsia.hardware.spmi/spmi.fidl
<EMPTY>
Device_CancelWatchControllerWriteCommands_Response
定義於 fuchsia.hardware.spmi/spmi.fidl
<EMPTY>
Device_RegisterRead_Response
定義於 fuchsia.hardware.spmi/spmi.fidl
| 欄位 | 類型 | 說明 | 預設 |
|---|---|---|---|
data |
vector<uint8>
|
無預設值 |
Device_RegisterWrite_Response
定義於 fuchsia.hardware.spmi/spmi.fidl
<EMPTY>
Device_WatchControllerWriteCommands_Response resource
定義於 fuchsia.hardware.spmi/spmi.fidl
| 欄位 | 類型 | 說明 | 預設 |
|---|---|---|---|
writes |
vector<Register8>:256
|
無預設值 | |
wake_lease |
fuchsia.power.system/LeaseToken
|
無預設值 |
Register8
定義於 fuchsia.hardware.spmi/spmi.fidl
使用 8 位元位址的 SPMI 指令讀取或寫入單一暫存器。
| 欄位 | 類型 | 說明 | 預設 |
|---|---|---|---|
address |
uint8
|
無預設值 | |
data |
uint8
|
無預設值 |
ENUMS
DriverError 彈性
類型:uint32
定義於 fuchsia.hardware.spmi/spmi.fidl
這個驅動程式庫可能傳回的錯誤。
| 名稱 | 值 | 說明 |
|---|---|---|
內部 |
1 |
驅動程式在執行作業時發生不明錯誤。 |
NOT_SUPPORTED |
2 |
系統未導入、不支援或未啟用這項作業。 |
INVALID_ARGS |
3 |
引數無效。 |
BAD_STATE |
4 |
作業失敗,因為驅動程式庫目前狀態不允許,或未滿足作業的前提條件。 |
IO_REFUSED |
5 |
裝置傳回 NACK (否定確認)。如果因同位檢查錯誤等原因而傳送 NACK,用戶端可能會重試作業。 |
已取消 |
6 |
hanging-get 方法已取消。 |
NOT_FOUND |
7 |
找不到符合指定引數的待處理 hanging-get 方法。 |
TABLES
ControllerInfo
定義於 fuchsia.hardware.spmi/metadata.fidl
ControllerInfo 會透過中繼資料傳遞至 SPMI 控制器驅動程式。
| 序數 | 欄位 | 類型 | 說明 |
|---|---|---|---|
1 |
id |
uint32
|
主機板專屬控制器 ID。(選用) |
2 |
targets |
vector<TargetInfo>:16
|
這個匯流排上的 SPMI 目標裝置。(選用) |
DebugGetControllerPropertiesResponse
定義於 fuchsia.hardware.spmi/spmi.fidl
| 序數 | 欄位 | 類型 | 說明 |
|---|---|---|---|
1 |
name |
string:64
|
控制器名稱的使用者易記字串。如未設定,控制器名稱會是「unknown」。如有這個字串,則不得為空白。 (選用) |
Device_GetProperties_Response
定義於 fuchsia.hardware.spmi/spmi.fidl
| 序數 | 欄位 | 類型 | 說明 |
|---|---|---|---|
1 |
sid |
uint8
|
專屬 SPMI 目標/次要 ID,對應至 SPMI 規格 sid。最多可識別 16 個次要裝置,ID 介於 0 到 15 之間 (含 0 和 15)。 必填。 |
2 |
name |
string:64
|
裝置名稱的易記字串。如未設定,裝置名稱會顯示為「不明」。如有這個字串,則不得為空白。 (選用) |
3 |
register_width_bytes |
uint32
|
裝置中每個暫存器的寬度 (以位元組為單位)。如未設定,暫存器寬度預設為 1 個位元組。 (選用) |
SubTargetInfo
定義於 fuchsia.hardware.spmi/metadata.fidl
| 序數 | 欄位 | 類型 | 說明 |
|---|---|---|---|
1 |
address |
uint16
|
SPMI 基本暫存器位址。這個子目標的存取權會限制在 [0, |
2 |
size |
uint32
|
這個子目標可存取的 SPMI 暫存器區域大小。 |
3 |
name |
string:64
|
這個子目標的名稱,用於繫結屬性。(選用) |
4 |
display_name |
string
|
這個子目標的人類可讀名稱。(選用) |
5 |
global_id |
uint32
|
所有 SPMI 子目標的全域專屬 ID。必填。 |
TargetInfo
定義於 fuchsia.hardware.spmi/metadata.fidl
| 序數 | 欄位 | 類型 | 說明 |
|---|---|---|---|
1 |
id |
uint8
|
SPMI 目標 ID 介於 [0, |
2 |
sub_targets |
vector<SubTargetInfo>:65536
|
這個目標中的子目標註冊區域。(選用) |
3 |
name |
string:64
|
這個目標的名稱,用於繫結屬性。(選用) |
4 |
display_name |
string
|
這個目標的人類可讀名稱。(選用) |
UNIONS
Debug_ConnectTarget_Result strict
定義於 fuchsia.hardware.spmi/spmi.fidl
| 序數 | Variant | 類型 | 說明 |
|---|---|---|---|
1 |
response |
Debug_ConnectTarget_Response
|
|
2 |
err |
DriverError
|
Device_CancelWatchControllerWriteCommands_Result strict
定義於 fuchsia.hardware.spmi/spmi.fidl
| 序數 | Variant | 類型 | 說明 |
|---|---|---|---|
1 |
response |
Device_CancelWatchControllerWriteCommands_Response
|
|
2 |
err |
DriverError
|
|
3 |
framework_err |
internal
|
Device_GetProperties_Result strict
定義於 fuchsia.hardware.spmi/spmi.fidl
| 序數 | Variant | 類型 | 說明 |
|---|---|---|---|
1 |
response |
Device_GetProperties_Response
|
|
3 |
framework_err |
internal
|
Device_RegisterRead_Result strict
定義於 fuchsia.hardware.spmi/spmi.fidl
| 序數 | Variant | 類型 | 說明 |
|---|---|---|---|
1 |
response |
Device_RegisterRead_Response
|
|
2 |
err |
DriverError
|
|
3 |
framework_err |
internal
|
Device_RegisterWrite_Result strict
定義於 fuchsia.hardware.spmi/spmi.fidl
| 序數 | Variant | 類型 | 說明 |
|---|---|---|---|
1 |
response |
Device_RegisterWrite_Response
|
|
2 |
err |
DriverError
|
|
3 |
framework_err |
internal
|
Device_WatchControllerWriteCommands_Result strict resource
定義於 fuchsia.hardware.spmi/spmi.fidl
| 序數 | Variant | 類型 | 說明 |
|---|---|---|---|
1 |
response |
Device_WatchControllerWriteCommands_Response
|
|
2 |
err |
DriverError
|
|
3 |
framework_err |
internal
|
常數
| 名稱 | 值 | 類型 | 說明 |
|---|---|---|---|
| MAX_CONTROLLER_WRITE_COMMANDS |
256
|
uint32 |
可傳回 |
| MAX_SPMI_NAME_LEN |
64
|
uint32 |
SPMI 裝置名稱長度上限。 |
| MAX_SUB_TARGETS |
65536
|
uint32 |
|
| MAX_TARGETS |
16
|
uint32 |
服務
DebugService
定義於 fuchsia.hardware.spmi/spmi.fidl
| 名稱 | 類型 | 傳輸 |
|---|---|---|
| 裝置 |
fuchsia.hardware.spmi/Debug
|
版本 |
SubTargetService
定義於 fuchsia.hardware.spmi/spmi.fidl
| 名稱 | 類型 | 傳輸 |
|---|---|---|
| 裝置 |
fuchsia.hardware.spmi/Device
|
版本 |
TargetService
定義於 fuchsia.hardware.spmi/spmi.fidl
| 名稱 | 類型 | 傳輸 |
|---|---|---|
| 裝置 |
fuchsia.hardware.spmi/Device
|
版本 |