[inventory] Add documentation

Signed-off-by: Boris Glimcher <Boris.Glimcher@emc.com>

Author: glimchb

common/v1/inventory.proto

@@ -16,48 +16,144 @@ service InventorySvc {
     rpc InventoryGet (InventoryGetRequest) returns (InventoryGetResponse) {}
 }
 
+// Doc taken from https://www.dmtf.org/sites/default/files/standards/documents/DSP0134_3.6.0.pdf
+
+// BIOS Information (Type 0)
 message BIOSInfo {
+    // String number of the BIOS Vendor’s Name.
     string vendor = 1;
+    // String number of the BIOS Version. This value is a
+    // free-form string that may contain Core and OEM
+    // version information.
     string version = 2;
+    // String number of the BIOS release date. The date
+    // string, if supplied, is in either mm/dd/yy or
+    // mm/dd/yyyy format. If the year portion of the string
+    // is two digits, the year is assumed to be 19yy.
+    // NOTE: The mm/dd/yyyy format is required for SMBIOS
+    // version 2.3 and later
     string date = 3;
 }
 
+// System Information (Type 1)
+//  The information in this structure defines attributes of the overall system and is intended to be associated
+//  with the Component ID group of the system’s MIF. An SMBIOS implementation is associated with a single
+//  system instance and contains one and only one System Information (Type 1) structure. Table 10 shows
+//  the contents of this structure.
 message SystemInfo {
+    // Number of null-terminated string
+    // This text string identifies the family to which a
+    // particular computer belongs. A family refers to a
+    // set of computers that are similar but not identical
+    // from a hardware or software point of view.
+    // Typically, a family is composed of different
+    // computer models, which have different
+    // configurations and pricing points. Computers in
+    // the same family often have similar branding and
+    // cosmetic features.
     string family = 1;
+    // Number of null-terminated string
     string name = 2;
+    // Number of null-terminated string
     string vendor = 3;
+    // Number of null-terminated string
     string serial_number = 4;
+    // A UUID is an identifier that is designed to be unique across both time and space. It requires no central
+    // registration process. The UUID is 128 bits long. Its format is described in RFC4122, but the actual field
+    // contents are opaque and not significant to the SMBIOS specification, which is only concerned with the
+    // byte order. Table 11 shows the field names; these field names, particularly for multiplexed fields, follow
+    // historical practice.
     string uuid = 5;
+    // Number of null-terminated string
+    // This text string identifies a particular computer
+    // configuration for sale. It is sometimes also called
+    // a product ID or purchase order number. This
+    // number is frequently found in existing fields, but
+    // there is no standard format. Typically for a given
+    // system board from a given OEM, there are tens
+    // of unique processor, memory, hard drive, and
+    // optical drive configurations.
     string sku = 6;
+    // Number of null-terminated string
     string version = 7;
 }
 
+// System Enclosure or Chassis (Type 3)
+//  The information in this structure (see Table 16) defines attributes of the system’s mechanical
+//  enclosure(s). For example, if a system included a separate enclosure for its peripheral devices, two
+//  structures would be returned: one for the main system enclosure and the second for the peripheral device
+//  enclosure. The additions to this structure in version 2.1 of this specification support the population of the
+//  CIM_Chassis class.
 message ChassisInfo{
+    // Number of null-terminated string
     string asset_tag = 1;
+    // Number of null-terminated string
     string serial_number = 2;
+    // Bit 7 Chassis lock is present if 1.
+    // Otherwise, either a lock is not present, or it is unknown if the enclosure has a lock.
+    // Bits 6:0 Enumeration value; see below. 
     string type = 3;
+    // Table 17 shows the byte values for the System Enclosure or Chassis Types field
+    // Number of null-terminated string
     string type_description = 4;
+    // Number of null-terminated string
     string vendor = 5;
+    // Number of null-terminated string
     string version = 6;
 }
 
+// Baseboard (or Module) Information (Type 2)
+//  The information in this structure defines attributes of a system baseboard (for
+//  example, a motherboard, planar, server blade, or other standard system module)
 message BaseboardInfo{
+    // Number of a null-terminated string
     string asset_tag = 1;
+    // Number of null-terminated string
     string serial_number = 2;
+    // Number of null-terminated string
     string vendor = 3;
+    // Number of null-terminated string
     string version = 4;
+    // Number of null-terminated string
     string product = 5;
 }
 
+// Processor Information (Type 4)
+//  The information in this structure (see Table 21) defines the attributes of a single processor; a separate
+//  structure instance is provided for each system processor socket/slot. For example, a system with an
+//  IntelDX2™ processor would have a single structure instance while a system with an IntelSX2™ processor
+//  would have a structure to describe the main CPU and a second structure to describe the 80487 co1054 processor.
 message CPUInfo{
+    // Number of cores per processor socket
+    // See 7.5.6. If the value is unknown, the field is set
+    // to 0. For core counts of 256 or greater, the Core
+    // Count field is set to FFh and the Core Count 2
+    // field is set to the number of cores.
     int32 total_cores = 1;
+    // Number of threads per processor socket
+    // See 7.5.8. If the value is unknown, the field is set
+    // to 0. For thread counts of 256 or greater, the
+    // Thread Count field is set to FFh and the Thread
+    // Count 2 field is set to the number of threads.
     int32 total_threads = 2;
 }
 
+// Physical Memory Array (Type 16)
+//  This structure describes a collection of memory devices that operate together to form a memory address
+//  space.
 message MemoryInfo{
+    // Maximum memory capacity, in kilobytes, for this array
+    // If the capacity is not represented in this field, then this
+    // field contains 8000 0000h and the Extended
+    // Maximum Capacity field should be used. Values 2 TB
+    // (8000 0000h) or greater must be represented in the
+    // Extended Maximum Capacity field.
     int64 total_physical_bytes = 1;
+    // TBD
     int64 total_usable_bytes = 2;
 }
+
+// TODO: remove this message
 message DeviceInfo {
     string name = 1;
     string description = 2;