EFI_BATTERY_CHARGING_PROTOCOL.GetBatteryStatus
GetBatteryStatusメインバッテリの現在の状態に関する情報を返します。
構文
typedef EFI_STATUS (EFIAPI * EFI_BATTERY_CHARGING_GET_BATTERY_STATUS) (
IN EFI_BATTERY_CHARGING_PROTOCOL *This,
OUT UINT32 *StateOfCharge,
OUT UINT32 *RatedCapacity,
OUT INT32 *ChargeCurrent );
パラメーター
This
[in] EFI_BATTERY_CHARGING_PROTOCOL インスタンスへのポインター。
StateOfCharge
[out] メインバッテリの充電 (SOC) の現在の状態を返します。 SOCはパーセンテージで表され、100%は完全な充電を示します。
RatedCapacity
[out] メインバッテリの定格容量をmAh単位で返します。
ChargeCurrent
[out] バッテリが充電中の場合は、mAのバッテリに配信される現在を示す正の数を返します。 バッテリが放電中の場合は、mAのバッテリから描画されている現在を示す負の数を返します。 バッテリが充電されていないか、放電されている場合は、0を返します。 ハードウェアがこの情報を提供できない場合は、FI_BATTERY_CHARGE_CURRENT_NOT_SUPPORTED (0x80000000) が返されます。
戻り値
次のステータスコードのいずれかを返します。
状態コード | 説明 |
---|---|
EFI_SUCCESS | 関数が正常に返されました。 |
EFI_INVALID_PARAMETER | パラメーターが正しくありませんでした。 |
EFI_DEVICE_ERROR | 物理デバイスでエラーが報告されました。 |
EFI_NOT_READY | 物理デバイスがビジー状態か、この要求を処理する準備ができていません。 |
解説
この関数は、メインバッテリの定格容量と充電状態 (SOC) を返します。 この関数は、このプロトコルを実装するドライバーによる追加の処理を支援するために定期的に呼び出されます。
要件
ヘッダー: ユーザーが生成しました