Changeset 81137 in vbox for trunk/include/iprt

Timestamp:

Oct 8, 2019 8:28:31 AM (5 years ago)

Author:

vboxsync

Message:

IPRT/RTSystem*Firmware: Simplified the interface and made it follow the style of the rest of RTSystemQuery*. Added RTSystemFirmwareTypeName() to avoid duplicating enum->string code over and over again.

Location:

trunk/include/iprt

Files:

• mangling.h (modified) (1 diff)
• system.h (modified) (2 diffs)

trunk/include/iprt/mangling.h

@@ -2221 +2221 @@
 # define RTSymlinkRead                                  RT_MANGLER(RTSymlinkRead)
 # define RTSymlinkReadA                                 RT_MANGLER(RTSymlinkReadA)
-# define RTSystemFirmwareQueryType                      RT_MANGLER(RTSystemFirmwareQueryType)
-# define RTSystemFirmwareQueryValue                     RT_MANGLER(RTSystemFirmwareQueryValue)
-# define RTSystemFirmwareFreeValue                      RT_MANGLER(RTSystemFirmwareFreeValue)
+# define RTSystemQueryFirmwareType                      RT_MANGLER(RTSystemQueryFirmwareType)
+# define RTSystemQueryFirmwareBoolean                   RT_MANGLER(RTSystemQueryFirmwareBoolean)
+# define RTSystemFirmwareTypeName                       RT_MANGLER(RTSystemFirmwareTypeName)
 # define RTSystemIsInsideVM                             RT_MANGLER(RTSystemIsInsideVM)
 # define RTSystemQueryAvailableRam                      RT_MANGLER(RTSystemQueryAvailableRam)

trunk/include/iprt/system.h

@@ -288 +288 @@
  * @param   penmType    Where to return the firmware type on success.
  */
-RTDECL(int) RTSystemFirmwareQueryType(PRTSYSFWTYPE penmType);
-
-/**
- * Enumeration for defining a system firmware value type.
- */
-typedef enum RTSYSFWVALUETYPE
-{
-    /** Invalid value type. */
-    RTSYSFWVALUETYPE_INVALID = 0,
-    /** Value is of type boolean. */
-    RTSYSFWVALUETYPE_BOOLEAN,
-    /** The usual 32-bit hack.  */
-    RTSYSFWVALUETYPE_32_BIT_HACK = 0x7fffffff
-} RTSYSFWVALUETYPE;
-
-/**
- * Structure for keeping a system firmware value.
- */
-typedef struct RTSYSFWVALUE
-{
-    /** Value type. */
-    RTSYSFWVALUETYPE enmType;
-    union
-    {
-        /** Boolean value. */
-        bool fVal;
-    } u;
-} RTSYSFWVALUE;
-/** Pointer to a system firmware value. */
-typedef RTSYSFWVALUE *PRTSYSFWVALUE;
+RTDECL(int) RTSystemQueryFirmwareType(PRTSYSFWTYPE penmType);
+
+/**
+ * Translates the @a enmType value to a string.
+ *
+ * @returns Read-only name.
+ * @param   enmType     The firmware type to convert to string.
+ */
+RTDECL(const char *) RTSystemFirmwareTypeName(RTSYSFWTYPE enmType);
 
 /**
@@ -342 +321 @@
  *          supported.
  * @param   enmProp     The property to query the value of.
- * @param   pValue      Where to return the value.  This is always zero'ed.
- */
-RTDECL(int) RTSystemFirmwareQueryValue(RTSYSFWPROP enmProp, PRTSYSFWVALUE pValue);
-
-/**
- * Free any allocations associated with a value returned by
- * RTSystemFirmwareQueryValue().
- *
- * @param   pValue  Result of a successful RTSystemFirmwareQueryValue() call.
- */
-RTDECL(void) RTSystemFirmwareFreeValue(PRTSYSFWVALUE pValue);
+ * @param   pfValue     Where to return the value.
+ */
+RTDECL(int) RTSystemQueryFirmwareBoolean(RTSYSFWPROP enmProp, bool *pfValue);
 
 #ifdef RT_OS_WINDOWS