1 /*
2  * Copyright (C) 2003-2015 FreeIPMI Core Team
3  *
4  * This program is free software: you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation, either version 3 of the License, or
7  * (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
16  *
17  */
18 
19 #ifndef IPMI_SOL_CMDS_TEMPLATES_H
20 #define IPMI_SOL_CMDS_TEMPLATES_H
21 
22 #ifdef __cplusplus
23 extern "C" {
24 #endif
25 
26 /* This header file is for documentation only */
27 
28 #if 0
29 
30 Please see fiid.h for details concerning the fiid interface.
31 
32 The following list the configurable fields of individual packet/record
33 templates in FreeIPMI.  Each field is listed as a list of the
34 following.
35 
36 { bits, "field name", field flag, field flag, ... }
37 
38 bits - indicates the number of bits in the field
39 
40 field name - indicates the name of the field, used for getting/setting
41              fields in the fiid API.
42 
43 field flags - flags indicating qualities of the field.  The following
44               qualities may exist for each field.
45 
46     REQUIRED - field is required for the packet/record
47     OPTIONAL - field is optional for the packet/record
48 
49     LENGTH-FIXED - field length is fixed at the number of bits listed
50 
51     LENGTH-VARIABLE - field length is variable for the number of bits
52                       listed
53 
54     MAKES-PACKET-SUFFICIENT - indicates field or fields are
55                               "sufficient" to make a packet/record valid
56                               and not malformed, but not necessarily a
57                               complete packet/record.
58 
59 Set SOL Configuration Parameters Request
60 ----------------------------------------
61 
62 FIID Template: tmpl_cmd_set_sol_configuration_parameters_rq
63 
64     { 8, "cmd", REQUIRED, LENGTH-FIXED }
65     { 4, "channel_number", REQUIRED, LENGTH-FIXED }
66     { 4, "reserved", REQUIRED, LENGTH-FIXED }
67     { 8, "parameter_selector", REQUIRED, LENGTH-FIXED }
68     { 1024, "configuration_parameter_data", REQUIRED, LENGTH-VARIABLE }
69 
70 Set SOL Configuration Parameters Response
71 -----------------------------------------
72 
73 FIID Template: tmpl_cmd_set_sol_configuration_parameters_rs
74 
75     { 8, "cmd", REQUIRED, LENGTH-FIXED, MAKES-PACKET-SUFFICIENT }
76     { 8, "comp_code", REQUIRED, LENGTH-FIXED, MAKES-PACKET-SUFFICIENT }
77 
78 Set SOL Configuration Parameters (Set In Progress) Request
79 ----------------------------------------------------------
80 
81 FIID Template: tmpl_cmd_set_sol_configuration_parameters_set_in_progress_rq
82 
83     { 8, "cmd", REQUIRED, LENGTH-FIXED }
84     { 4, "channel_number", REQUIRED, LENGTH-FIXED }
85     { 4, "reserved1", REQUIRED, LENGTH-FIXED }
86     { 8, "parameter_selector", REQUIRED, LENGTH-FIXED }
87     { 2, "state", REQUIRED, LENGTH-FIXED }
88     { 6, "reserved2", REQUIRED, LENGTH-FIXED }
89 
90 Set SOL Configuration Parameters (SOL Enable) Request
91 -----------------------------------------------------
92 
93 FIID Template: tmpl_cmd_set_sol_configuration_parameters_sol_enable_rq
94 
95     { 8, "cmd", REQUIRED, LENGTH-FIXED }
96     { 4, "channel_number", REQUIRED, LENGTH-FIXED }
97     { 4, "reserved1", REQUIRED, LENGTH-FIXED }
98     { 8, "parameter_selector", REQUIRED, LENGTH-FIXED }
99     { 1, "sol_enable", REQUIRED, LENGTH-FIXED }
100     { 7, "reserved2", REQUIRED, LENGTH-FIXED }
101 
102 Set SOL Configuration Parameters (SOL Authentication) Request
103 --------------------------------------------------------------
104 
105 FIID Template: tmpl_cmd_set_sol_configuration_parameters_sol_authentication_rq
106 
107     { 8, "cmd", REQUIRED, LENGTH-FIXED }
108     { 4, "channel_number", REQUIRED, LENGTH-FIXED }
109     { 4, "reserved1", REQUIRED, LENGTH-FIXED }
110     { 8, "parameter_selector", REQUIRED, LENGTH-FIXED }
111     { 4, "sol_privilege_level", REQUIRED, LENGTH-FIXED }
112     { 2, "reserved2", REQUIRED, LENGTH-FIXED }
113     { 1, "force_sol_payload_authentication", REQUIRED, LENGTH-FIXED }
114     { 1, "force_sol_payload_encryption", REQUIRED, LENGTH-FIXED }
115 
116 Set SOL Configuration Parameters (Character Accumulate Interval and Send Threshold) Request
117 -------------------------------------------------------------------------------------------
118 
119 FIID Template: tmpl_cmd_set_sol_configuration_parameters_character_accumulate_interval_and_send_threshold_rq
120 
121     { 8, "cmd", REQUIRED, LENGTH-FIXED }
122     { 4, "channel_number", REQUIRED, LENGTH-FIXED }
123     { 4, "reserved1", REQUIRED, LENGTH-FIXED }
124     { 8, "parameter_selector", REQUIRED, LENGTH-FIXED }
125     { 8, "character_accumulate_interval", REQUIRED, LENGTH-FIXED }
126     { 8, "character_send_threshold", REQUIRED, LENGTH-FIXED }
127 
128 Set SOL Configuration Parameters (SOL Retry) Request
129 ----------------------------------------------------
130 
131 FIID Template: tmpl_cmd_set_sol_configuration_parameters_sol_retry_rq
132 
133     { 8, "cmd", REQUIRED, LENGTH-FIXED }
134     { 4, "channel_number", REQUIRED, LENGTH-FIXED }
135     { 4, "reserved1", REQUIRED, LENGTH-FIXED }
136     { 8, "parameter_selector", REQUIRED, LENGTH-FIXED }
137     { 3, "retry_count", REQUIRED, LENGTH-FIXED }
138     { 5, "reserved2", REQUIRED, LENGTH-FIXED }
139     { 8, "retry_interval", REQUIRED, LENGTH-FIXED }
140 
141 Set SOL Configuration Parameters (SOL Non-Volatile Bit Rate) Request
142 --------------------------------------------------------------------
143 
144 FIID Template: tmpl_cmd_set_sol_configuration_parameters_sol_non_volatile_bit_rate_rq
145 
146     { 8, "cmd", REQUIRED, LENGTH-FIXED }
147     { 4, "channel_number", REQUIRED, LENGTH-FIXED }
148     { 4, "reserved1", REQUIRED, LENGTH-FIXED }
149     { 8, "parameter_selector", REQUIRED, LENGTH-FIXED }
150     { 4, "bit_rate", REQUIRED, LENGTH-FIXED }
151     { 4, "reserved2", REQUIRED, LENGTH-FIXED }
152 
153 Set SOL Configuration Parameters (SOL Volatile Bit Rate) Request
154 ----------------------------------------------------------------
155 
156 FIID Template: tmpl_cmd_set_sol_configuration_parameters_sol_volatile_bit_rate_rq
157 
158     { 8, "cmd", REQUIRED, LENGTH-FIXED }
159     { 4, "channel_number", REQUIRED, LENGTH-FIXED }
160     { 4, "reserved1", REQUIRED, LENGTH-FIXED }
161     { 8, "parameter_selector", REQUIRED, LENGTH-FIXED }
162     { 4, "bit_rate", REQUIRED, LENGTH-FIXED }
163     { 4, "reserved2", REQUIRED, LENGTH-FIXED }
164 
165 Set SOL Configuration Parameters (SOL Payload Port Number) Request
166 ------------------------------------------------------------------
167 
168 FIID Template: tmpl_cmd_set_sol_configuration_parameters_sol_payload_port_number_rq
169 
170     { 8, "cmd", REQUIRED, LENGTH-FIXED }
171     { 4, "channel_number", REQUIRED, LENGTH-FIXED }
172     { 4, "reserved1", REQUIRED, LENGTH-FIXED }
173     { 8, "parameter_selector", REQUIRED, LENGTH-FIXED }
174     { 16, "port_number", REQUIRED, LENGTH-FIXED }
175 
176 Get SOL Configuration Parameters Request
177 ----------------------------------------
178 
179 FIID Template: tmpl_cmd_get_sol_configuration_parameters_rq
180 
181     { 8, "cmd", REQUIRED, LENGTH-FIXED }
182     { 4, "channel_number", REQUIRED, LENGTH-FIXED }
183     { 3, "reserved", REQUIRED, LENGTH-FIXED }
184     { 1, "get_parameter", REQUIRED, LENGTH-FIXED }
185     { 8, "parameter_selector", REQUIRED, LENGTH-FIXED }
186     { 8, "set_selector", REQUIRED, LENGTH-FIXED }
187     { 8, "block_selector", REQUIRED, LENGTH-FIXED }
188 
189 Get SOL Configuration Parameters Response
190 -----------------------------------------
191 
192 FIID Template: tmpl_cmd_get_sol_configuration_parameters_rs
193 
194     { 8, "cmd", REQUIRED, LENGTH-FIXED, MAKES-PACKET-SUFFICIENT }
195     { 8, "comp_code", REQUIRED, LENGTH-FIXED, MAKES-PACKET-SUFFICIENT }
196     { 4, "present_revision", REQUIRED, LENGTH-FIXED }
197     { 4, "oldest_revision_parameter", REQUIRED, LENGTH-FIXED }
198     { 1024, "configuration_parameter_data", REQUIRED, LENGTH-VARIABLE }
199 
200 Get SOL Configuration Parameters (Set In Progress) Response
201 -----------------------------------------------------------
202 
203 FIID Template: tmpl_cmd_get_sol_configuration_parameters_set_in_progress_rs
204 
205     { 8, "cmd", REQUIRED, LENGTH-FIXED, MAKES-PACKET-SUFFICIENT }
206     { 8, "comp_code", REQUIRED, LENGTH-FIXED, MAKES-PACKET-SUFFICIENT }
207     { 4, "present_revision", REQUIRED, LENGTH-FIXED }
208     { 4, "oldest_revision_parameter", REQUIRED, LENGTH-FIXED }
209     { 2, "state", REQUIRED, LENGTH-FIXED }
210     { 6, "reserved", REQUIRED, LENGTH-FIXED }
211 
212 Get SOL Configuration Parameters (SOL Enable) Response
213 ------------------------------------------------------
214 
215 FIID Template: tmpl_cmd_get_sol_configuration_parameters_sol_enable_rs
216 
217     { 8, "cmd", REQUIRED, LENGTH-FIXED, MAKES-PACKET-SUFFICIENT }
218     { 8, "comp_code", REQUIRED, LENGTH-FIXED, MAKES-PACKET-SUFFICIENT }
219     { 4, "present_revision", REQUIRED, LENGTH-FIXED }
220     { 4, "oldest_revision_parameter", REQUIRED, LENGTH-FIXED }
221     { 1, "sol_enable", REQUIRED, LENGTH-FIXED }
222     { 7, "reserved", REQUIRED, LENGTH-FIXED }
223 
224 Get SOL Configuration Parameters (SOL Authentication) Response
225 --------------------------------------------------------------
226 
227 FIID Template: tmpl_cmd_get_sol_configuration_parameters_sol_authentication_rs
228 
229     { 8, "cmd", REQUIRED, LENGTH-FIXED, MAKES-PACKET-SUFFICIENT }
230     { 8, "comp_code", REQUIRED, LENGTH-FIXED, MAKES-PACKET-SUFFICIENT }
231     { 4, "present_revision", REQUIRED, LENGTH-FIXED }
232     { 4, "oldest_revision_parameter", REQUIRED, LENGTH-FIXED }
233     { 4, "sol_privilege_level", REQUIRED, LENGTH-FIXED }
234     { 2, "reserved", REQUIRED, LENGTH-FIXED }
235     { 1, "force_sol_payload_authentication", REQUIRED, LENGTH-FIXED }
236     { 1, "force_sol_payload_encryption", REQUIRED, LENGTH-FIXED }
237 
238 Get SOL Configuration Parameters (Character Accumulate Interval and Send Threshold) Response
239 --------------------------------------------------------------------------------------------
240 
241 FIID Template: tmpl_cmd_get_sol_configuration_parameters_character_accumulate_interval_and_send_threshold_rs
242 
243     { 8, "cmd", REQUIRED, LENGTH-FIXED, MAKES-PACKET-SUFFICIENT }
244     { 8, "comp_code", REQUIRED, LENGTH-FIXED, MAKES-PACKET-SUFFICIENT }
245     { 4, "present_revision", REQUIRED, LENGTH-FIXED }
246     { 4, "oldest_revision_parameter", REQUIRED, LENGTH-FIXED }
247     { 8, "character_accumulate_interval", REQUIRED, LENGTH-FIXED }
248     { 8, "character_send_threshold", REQUIRED, LENGTH-FIXED }
249 
250 Get SOL Configuration Parameters (SOL Retry) Response
251 -----------------------------------------------------
252 
253 FIID Template: tmpl_cmd_get_sol_configuration_parameters_sol_retry_rs
254 
255     { 8, "cmd", REQUIRED, LENGTH-FIXED, MAKES-PACKET-SUFFICIENT }
256     { 8, "comp_code", REQUIRED, LENGTH-FIXED, MAKES-PACKET-SUFFICIENT }
257     { 4, "present_revision", REQUIRED, LENGTH-FIXED }
258     { 4, "oldest_revision_parameter", REQUIRED, LENGTH-FIXED }
259     { 3, "retry_count", REQUIRED, LENGTH-FIXED }
260     { 5, "reserved", REQUIRED, LENGTH-FIXED }
261     { 8, "retry_interval", REQUIRED, LENGTH-FIXED }
262 
263 Get SOL Configuration Parameters (SOL Non-Volatile Bit Rate) Response
264 ---------------------------------------------------------------------
265 
266 FIID Template: tmpl_cmd_get_sol_configuration_parameters_sol_non_volatile_bit_rate_rs
267 
268     { 8, "cmd", REQUIRED, LENGTH-FIXED, MAKES-PACKET-SUFFICIENT }
269     { 8, "comp_code", REQUIRED, LENGTH-FIXED, MAKES-PACKET-SUFFICIENT }
270     { 4, "present_revision", REQUIRED, LENGTH-FIXED }
271     { 4, "oldest_revision_parameter", REQUIRED, LENGTH-FIXED }
272     { 4, "bit_rate", REQUIRED, LENGTH-FIXED }
273     { 4, "reserved", REQUIRED, LENGTH-FIXED }
274 
275 Get SOL Configuration Parameters (SOL Volatile Bit Rate) Response
276 -----------------------------------------------------------------
277 
278 FIID Template: tmpl_cmd_get_sol_configuration_parameters_sol_volatile_bit_rate_rs
279 
280     { 8, "cmd", REQUIRED, LENGTH-FIXED, MAKES-PACKET-SUFFICIENT }
281     { 8, "comp_code", REQUIRED, LENGTH-FIXED, MAKES-PACKET-SUFFICIENT }
282     { 4, "present_revision", REQUIRED, LENGTH-FIXED }
283     { 4, "oldest_revision_parameter", REQUIRED, LENGTH-FIXED }
284     { 4, "bit_rate", REQUIRED, LENGTH-FIXED }
285     { 4, "reserved", REQUIRED, LENGTH-FIXED }
286 
287 Get SOL Configuration Parameters (SOL Payload Channel) Response
288 ---------------------------------------------------------------
289 
290 FIID Template: tmpl_cmd_get_sol_configuration_parameters_sol_payload_channel_rs
291 
292     { 8, "cmd", REQUIRED, LENGTH-FIXED, MAKES-PACKET-SUFFICIENT }
293     { 8, "comp_code", REQUIRED, LENGTH-FIXED, MAKES-PACKET-SUFFICIENT }
294     { 4, "present_revision", REQUIRED, LENGTH-FIXED }
295     { 4, "oldest_revision_parameter", REQUIRED, LENGTH-FIXED }
296     { 8, "payload_channel", REQUIRED, LENGTH-FIXED }
297 
298   Notes: Read only field, no "set" equivalent.
299 
300 Get SOL Configuration Parameters (SOL Payload Port Number) Response
301 -------------------------------------------------------------------
302 
303 FIID Template: tmpl_cmd_get_sol_configuration_parameters_sol_payload_port_number_rs
304 
305     { 8, "cmd", REQUIRED, LENGTH-FIXED, MAKES-PACKET-SUFFICIENT }
306     { 8, "comp_code", REQUIRED, LENGTH-FIXED, MAKES-PACKET-SUFFICIENT }
307     { 4, "present_revision", REQUIRED, LENGTH-FIXED }
308     { 4, "oldest_revision_parameter", REQUIRED, LENGTH-FIXED }
309     { 16, "port_number", REQUIRED, LENGTH-FIXED }
310 
311 #endif  /* 0 */
312 
313 #ifdef __cplusplus
314 }
315 #endif
316 
317 #endif /* IPMI_SOL_CMDS_TEMPLATES_H */
318