Merge branch 'wip-internal-use-area'

Add support for FRU Internal Use Area

Author: patrislav1

README.md

@@ -20,7 +20,7 @@ pip3 install git+https://github.com/MicroTCA-Tech-Lab/frugy
 $ frugy --help
 usage: frugy [-h] [--version] [-o OUTPUT] [-w] [-r] [-d]
              [-e EEPROM_SIZE] [-s SET] [-t] [-b] [-c] [-l [LIST]]
-             [-v VERBOSITY]
+             [-v VERBOSITY] [--internal-area-size SIZE]
              [srcfile]
 
 FRU Generator YAML

frugy/areas.py

@@ -10,7 +10,7 @@
 #                                                                         #
 ###########################################################################
 
-from frugy.types import FruAreaVersioned, FruAreaSized, FixedField, StringField, StringField, bin2hex_helper, CustomStringArray
+from frugy.types import FruAreaInternalUse, FruAreaVersioned, FruAreaSized, FixedField, StringField, StringField, bin2hex_helper, CustomStringArray, BytearrayField
 from frugy.fru_registry import FruRecordType, rec_register
 from datetime import datetime, timedelta
 import logging
@@ -152,3 +152,12 @@ class ProductInfo(FruAreaSized):
         ('fru_file_id', StringField),
         ('custom_info_fields', CustomStringArray),
     ]
+
+
+@ipmi_area
+class InternalUse(FruAreaInternalUse):
+    ''' Platform Management FRU Information Storage Definition, Table 9-1 '''
+
+    _schema = [
+        ('data', BytearrayField),
+    ]

frugy/cli.py

@@ -20,7 +20,7 @@
 from frugy.__init__ import __version__
 from frugy.fru import Fru
 from frugy.fru_registry import FruRecordType, rec_enumerate, rec_lookup_by_name, rec_info, schema_entry_info
-from frugy.types import FruAreaChecksummed
+from frugy.types import FruAreaChecksummed, FruAreaInternalUse
 from frugy.multirecords import MultirecordEntry
 
 
@@ -135,6 +135,11 @@ def main():
                         nargs='?',
                         help='list supported FRU records or schema of specified record'
                         )
+
+    parser.add_argument('--internal-area-size',
+                        type=int,
+                        help='set fixed size for internal use area (including format byte)'
+                        )
     parser.add_argument('-v', '--verbosity',
                         type=int,
                         help='set verbosity (0=quiet, 1=info, 2=debug)'
@@ -163,7 +168,7 @@ def main():
         parser.print_help(sys.stderr)
         sys.exit(1)
 
-    if read_mode and (args.eeprom_size is not None or args.set or args.timestamp):
+    if read_mode and (args.eeprom_size is not None or args.set or args.timestamp or args.internal_area_size):
         parser.print_help(sys.stderr)
         sys.exit(1)
 
@@ -173,6 +178,14 @@ def main():
     if read_mode and args.ignore_checksum_errors:
         FruAreaChecksummed.ignore_checksum_errors = True
 
+    if args.internal_area_size and args.internal_area_size % 8 != 0:
+        print("Internal area size must be a multiple of 8 bytes", file=sys.stderr)
+        sys.exit(1)
+
+    # In read mode, this isn't used, we always use the size of the section in
+    # the file since there is no length field.
+    FruAreaInternalUse.internal_area_size = args.internal_area_size
+
     outfile = args.output
     if args.dump:
         if outfile:

frugy/fru.py

@@ -12,7 +12,7 @@
 ####################################################################################
 
 from frugy import __version__
-from frugy.areas import CommonHeader, ChassisInfo, BoardInfo, ProductInfo
+from frugy.areas import CommonHeader, ChassisInfo, BoardInfo, ProductInfo, InternalUse
 from frugy.multirecords import MultirecordArea
 import frugy.multirecords_ipmi
 import frugy.multirecords_picmg
@@ -46,6 +46,7 @@ def import_log(msg):
 
 class Fru:
     _area_table_lookup = bidict({
+        'InternalUse': 'internal_use_offs',
         'ChassisInfo': 'chassis_info_offs',
         'BoardInfo': 'board_info_offs',
         'ProductInfo': 'product_info_offs',
@@ -61,6 +62,7 @@ def __init__(self, initdict=None):
 
     def factory(self, cls_name, cls_args=None):
         map = {
+            'InternalUse': InternalUse,
             'ChassisInfo': ChassisInfo,
             'BoardInfo': BoardInfo,
             'ProductInfo': ProductInfo,
@@ -103,13 +105,25 @@ def deserialize(self, input):
         import_log.str = ''
         self.areas = {}
         self.header.deserialize(input)
+
+        # The internal record does not have a length field in it,
+        # and it is just a byte array. So we have to find the start
+        # of the next record and slice the input on that boundary.
+        offsets = self.header.to_dict()
+        if "internal_use_offs" in offsets:
+            internal_use_start = offsets["internal_use_offs"]
+            internal_use_end = next(
+                (o for o in sorted(offsets.values()) if o > internal_use_start), None
+            )
+
         for k, v in self.header.to_dict().items():
-            # Ignore "internal use area"
-            # TODO: Support it as opaque byte array?
-            if v and k != 'internal_use_offs':
+            if v:
                 obj_name = self._area_table_lookup.inverse[k]
                 obj = self.factory(obj_name)
-                obj.deserialize(input[v:])
+                if k == "internal_use_offs" and internal_use_end is not None:
+                    obj.deserialize(input[v:internal_use_end])
+                else:
+                    obj.deserialize(input[v:])
                 self.areas[obj_name] = obj
 
     def load_yaml(self, fname):

frugy/types.py

@@ -791,6 +791,49 @@ def deserialize(self, input: bytearray):
         remainder = self._deserialize(input[1:])
         return self._verify_epilogue(input, len(input) - len(remainder))
 
+class FruAreaInternalUse(FruAreaBase):
+    ''' FRU Internal use area featuring a version field but no checksum, will
+    be padded to whatever internal area is specified'''
+
+    internal_area_size = None
+
+    def __init__(self, initdict=None):
+        self._format_version = _format_version_default
+        super().__init__(initdict=initdict)
+
+    def _set_format_version(self, val):
+        self._format_version = val
+
+    def _get_format_version(self):
+        return self._format_version
+
+    def _prologue(self) -> bytearray:
+        ''' return data to prepend (format version) '''
+        return self._format_version.to_bytes(1, 'little')
+
+    def _epilogue(self, payload: bytearray) -> bytearray:
+        ''' return data to append, padded of 0xff bytes'''
+        numPadBytes, _ = _sizeAlign(len(payload), self.internal_area_size or 8)
+        return b'\xff' * numPadBytes
+
+    def size_total(self) -> int:
+        # payload plus "format version" prologue
+        total_size_base = self.size_payload() + 1
+        _, total_size_base = _sizeAlign(total_size_base, self.internal_area_size or 8)
+        return total_size_base
+
+    def serialize(self) -> bytearray:
+        payload = self._prologue()
+        payload += self._serialize()
+        if self.internal_area_size and len(payload) > self.internal_area_size:
+            raise RuntimeError(f"internal area size ({self.internal_area_size}) too small; need at least {len(payload)} bytes")
+        return payload + self._epilogue(payload)
+        
+    def deserialize(self, input: bytearray):
+        logging.debug(f"bytearray: {input} len: {len(input)}")
+        self._format_version = input[0]
+        return self._deserialize(input[1:])
+
 
 class FruAreaSized(FruAreaVersioned):
     ''' FRU area featuring version and length fields '''