Skip to content

Commit 2fc3601

Browse files
authored
Add comments to PsmBatteryChargeInfoFields (#706)
1 parent 57da44f commit 2fc3601

1 file changed

Lines changed: 11 additions & 11 deletions

File tree

  • nx/include/switch/services

nx/include/switch/services/psm.h

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -60,23 +60,23 @@ typedef struct {
6060

6161
/// BatteryChargeInfoFields [17.0.0+]
6262
typedef struct {
63-
u32 input_current_limit;
64-
u32 boost_mode_current_limit;
65-
u32 fast_charge_current_limit;
66-
u32 charge_voltage_limit;
63+
u32 input_current_limit; ///< Input (Sink) current limit in mA
64+
u32 boost_mode_current_limit; ///< Output (Source/VBUS/OTG) current limit in mA
65+
u32 fast_charge_current_limit; ///< Battery charging current limit in mA
66+
u32 charge_voltage_limit; ///< Battery charging voltage limit in mV
6767
PsmChargerType charger_type;
6868
u8 hi_z_mode;
6969
bool battery_charging;
7070
u8 pad[2];
71-
PsmVdd50State vdd50_state;
72-
u32 temperature_celcius;
73-
u32 battery_charge_percentage;
74-
u32 battery_charge_milli_voltage;
75-
u32 battery_age_percentage;
71+
PsmVdd50State vdd50_state; ///< Power Delivery Controller State
72+
u32 temperature_celcius; ///< Battery temperature in milli C
73+
u32 battery_charge_percentage; ///< Raw battery charged capacity per cent-mille
74+
u32 battery_charge_milli_voltage; ///< Voltage average in mV
75+
u32 battery_age_percentage; ///< Battery age per cent-mille
7676
u32 usb_power_role;
7777
u32 usb_charger_type;
78-
u32 charger_input_voltage_limit;
79-
u32 charger_input_current_limit;
78+
u32 charger_input_voltage_limit; ///< Charger and external device voltage limit in mV
79+
u32 charger_input_current_limit; ///< Charger and external device current limit in mA
8080
bool fast_battery_charging;
8181
bool controller_power_supply;
8282
bool otg_request;

0 commit comments

Comments
 (0)