mirror of
https://opendev.org/x/pyghmi
synced 2025-07-22 04:01:12 +00:00
e5bfd786cb
While the base IPMI specification is quite comprehensive, there are various points where OEM enhancement is possible. This can run the gamut from entirely distinct function (e.g. remote graphics) to additional 'sensors' to providing more interesting decode of 'extra' fields in FRU to decoding otherwise indecipherable SEL events. Change-Id: Iaf670f336f225d0ea00e1803eebb84104a78e8b3
45 lines
1.9 KiB
Python
45 lines
1.9 KiB
Python
# vim: tabstop=4 shiftwidth=4 softtabstop=4
|
|
|
|
# Copyright 2015 Lenovo Corporation
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
|
|
class OEMHandler(object):
|
|
"""Handler class for OEM capabilities.
|
|
|
|
Any vendor wishing to implement OEM extensions should look at this
|
|
base class for an appropriate interface. If one does not exist, this
|
|
base class should be extended. At initialization an OEM is given
|
|
a dictionary with product_id, device_id, manufacturer_id, and
|
|
device_revision as keys in a dictionary, along with an ipmi Command object
|
|
"""
|
|
def __init__(self, oemid, ipmicmd):
|
|
pass
|
|
|
|
def process_fru(self, fru):
|
|
"""Modify a fru entry with OEM understanding.
|
|
|
|
Given a fru, clarify 'extra' fields according to OEM rules and
|
|
return the transformed data structure. If OEM processes, it is
|
|
expected that it sets 'oem_parser' to the name of the module. For
|
|
clients passing through data, it is suggested to pass through
|
|
board/product/chassis_extra_data arrays if 'oem_parser' is None,
|
|
and mask those fields if not None. It is expected that OEMs leave
|
|
the fields intact so that if client code hard codes around the
|
|
ordered lists that their expectations are not broken by an update
|
|
"""
|
|
# In the generic case, just pass through
|
|
fru['oem_parser'] = None
|
|
return fru
|