EFI_BATTERY_CHARGING_PROTOCOL.GetBatteryInformation

  • [アーティクル]

GetBatteryInformation充電の状態を含む、メインバッテリの現在の状態に関する情報を返します、バッテリに配信またはバッテリから描画される現在の量、バッテリの端子間の電圧、バッテリの温度、USBケーブル上の電圧、およびUSBケーブル経由の現在。

構文

typedef EFI_STATUS (EFIAPI * EFI_BATTERY_CHARGING_GET_BATTERY_INFORMATION) (
    IN EFI_BATTERY_CHARGING_PROTOCOL *This,
    OUT UINT32 *StateOfCharge,
    OUT INT32 *CurrentIntoBattery,
    OUT UINT32 *BatteryTerminalVoltage, 
    OUT INT32 *BatteryTemperature,
    OUT UINT32 *USBCableVoltage,
    OUT UINT32 *USBCableCurrent );

パラメーター

This
[in] EFI_BATTERY_CHARGING_PROTOCOL インスタンスへのポインター。

StateOfCharge
[out] メインバッテリの充電 (SOC) の現在の状態を返します。 SOCはパーセンテージで表されます。100%は完全な充電を示します。

CurrentIntoBattery
[out] 次の表に示す値のいずれかを返します。

値 説明
正の数 バッテリは充電中です。 値は、mAのバッテリに配信される現在を示します。
負の数 バッテリは放電中です。 値は、mAのバッテリから描画されている現在を示します。
0 バッテリが充電または放電されていません。
EFI_BATTERY_CHARGE_CURRENT_NOT_SUPPORTED (0x80000000) ハードウェアは、この情報を提供できません。

BatteryTerminalVoltage
[out] mVのバッテリ端子間の電圧。

BatteryTemperature
[out] ケルビン度の10thsのバッテリの温度。

USBCableVoltage
[out] mVのUSBケーブル上の電圧。

USBCableCurrent
[out] mAのUSBケーブル経由の現在。

戻り値

次のステータスコードのいずれかを返します。

状態コード 説明
EFI_SUCCESS 関数が正常に返されました。
EFI_INVALID_PARAMETER パラメーターが正しくありませんでした。
EFI_DEVICE_ERROR 物理デバイスでエラーが報告されました。
EFI_NOT_READY 物理デバイスがビジー状態か、この要求を処理する準備ができていません。

解説

この関数は、バッテリに関する情報を取得するUEFIバッテリ充電アプリケーションによって定期的に呼び出されます。 アプリケーションは、バッテリの状態を監視し、エラーを診断するために、この情報を使用します。

Note

この関数は、リビジョン 0x00010002 of the EFI_BATTERY_CHARGING_PROTOCOL 以降で使用できます。 呼び出すUEFIバッテリの充電アプリケーションがプロトコルのリビジョン0x00010001のみが使用可能であることを検出した場合 EFI_BATTERY_CHARGING_PROTOCOL.GetBatteryStatus 代わりにします。

要件

ヘッダー: ユーザーが生成しました

EFI_BATTERY_CHARGING_PROTOCOL