99 lines
2.9 KiB
C
99 lines
2.9 KiB
C
/*
|
|
* Copyright (C) 2003-2015 FreeIPMI Core Team
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*
|
|
*/
|
|
|
|
#ifndef IPMI_IPMB_INTERFACE_TEMPLATES_H
|
|
#define IPMI_IPMB_INTERFACE_TEMPLATES_H
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/* This header file is for documentation only */
|
|
|
|
#if 0
|
|
|
|
Please see fiid.h for details concerning the fiid interface.
|
|
|
|
The following list the configurable fields of individual packet/record
|
|
templates in FreeIPMI. Each field is listed as a list of the
|
|
following.
|
|
|
|
{ bits, "field name", field flag, field flag, ... }
|
|
|
|
bits - indicates the number of bits in the field
|
|
|
|
field name - indicates the name of the field, used for getting/setting
|
|
fields in the fiid API.
|
|
|
|
field flags - flags indicating qualities of the field. The following
|
|
qualities may exist for each field.
|
|
|
|
REQUIRED - field is required for the packet/record
|
|
OPTIONAL - field is optional for the packet/record
|
|
|
|
LENGTH-FIXED - field length is fixed at the number of bits listed
|
|
|
|
LENGTH-VARIABLE - field length is variable for the number of bits
|
|
listed
|
|
|
|
MAKES-PACKET-SUFFICIENT - indicates field or fields are
|
|
"sufficient" to make a packet/record valid
|
|
and not malformed, but not necessarily a
|
|
complete packet/record.
|
|
|
|
IPMB Message Header Request
|
|
---------------------------
|
|
|
|
FIID Template: tmpl_ipmb_msg_hdr_rq
|
|
|
|
{ 8, "rs_addr", REQUIRED, LENGTH-FIXED }
|
|
{ 2, "rs_lun", REQUIRED, LENGTH-FIXED }
|
|
{ 6, "net_fn", REQUIRED, LENGTH-FIXED }
|
|
{ 8, "checksum1", REQUIRED, LENGTH-FIXED }
|
|
{ 8, "rq_addr", REQUIRED, LENGTH-FIXED }
|
|
{ 2, "rq_lun", REQUIRED, LENGTH-FIXED }
|
|
{ 6, "rq_seq", REQUIRED, LENGTH-FIXED }
|
|
|
|
IPMB Message Header Response
|
|
----------------------------
|
|
|
|
FIID Template: tmpl_ipmb_msg_hdr_rs
|
|
|
|
{ 2, "rq_lun", REQUIRED, LENGTH-FIXED }
|
|
{ 6, "net_fn", REQUIRED, LENGTH-FIXED }
|
|
{ 8, "checksum1", REQUIRED, LENGTH-FIXED }
|
|
{ 8, "rs_addr", REQUIRED, LENGTH-FIXED }
|
|
{ 2, "rs_lun", REQUIRED, LENGTH-FIXED }
|
|
{ 6, "rq_seq", REQUIRED, LENGTH-FIXED }
|
|
|
|
FIID Template: tmpl_ipmb_msg_trlr
|
|
|
|
{ 8, "checksum2", REQUIRED, LENGTH-FIXED }
|
|
|
|
FIID Template: tmpl_ipmb_msg
|
|
|
|
{ 2040, "data", REQUIRED, LENGTH-VARIABLE }
|
|
|
|
#endif /* 0 */
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* IPMI_IPMB_INTERFACE_TEMPLATES_H */
|