xref: /onnv-gate/usr/src/lib/libfru/libfru/PayloadReader.h (revision 0:68f95e015346)
1*0Sstevel@tonic-gate /*
2*0Sstevel@tonic-gate  * CDDL HEADER START
3*0Sstevel@tonic-gate  *
4*0Sstevel@tonic-gate  * The contents of this file are subject to the terms of the
5*0Sstevel@tonic-gate  * Common Development and Distribution License, Version 1.0 only
6*0Sstevel@tonic-gate  * (the "License").  You may not use this file except in compliance
7*0Sstevel@tonic-gate  * with the License.
8*0Sstevel@tonic-gate  *
9*0Sstevel@tonic-gate  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10*0Sstevel@tonic-gate  * or http://www.opensolaris.org/os/licensing.
11*0Sstevel@tonic-gate  * See the License for the specific language governing permissions
12*0Sstevel@tonic-gate  * and limitations under the License.
13*0Sstevel@tonic-gate  *
14*0Sstevel@tonic-gate  * When distributing Covered Code, include this CDDL HEADER in each
15*0Sstevel@tonic-gate  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16*0Sstevel@tonic-gate  * If applicable, add the following below this CDDL HEADER, with the
17*0Sstevel@tonic-gate  * fields enclosed by brackets "[]" replaced with your own identifying
18*0Sstevel@tonic-gate  * information: Portions Copyright [yyyy] [name of copyright owner]
19*0Sstevel@tonic-gate  *
20*0Sstevel@tonic-gate  * CDDL HEADER END
21*0Sstevel@tonic-gate  */
22*0Sstevel@tonic-gate /*
23*0Sstevel@tonic-gate  * Copyright (c) 2000-2001 by Sun Microsystems, Inc.
24*0Sstevel@tonic-gate  * All rights reserved.
25*0Sstevel@tonic-gate  */
26*0Sstevel@tonic-gate 
27*0Sstevel@tonic-gate #ifndef	_PAYLOADREADER_H
28*0Sstevel@tonic-gate #define	_PAYLOADREADER_H
29*0Sstevel@tonic-gate 
30*0Sstevel@tonic-gate #pragma ident	"%Z%%M%	%I%	%E% SMI"
31*0Sstevel@tonic-gate 
32*0Sstevel@tonic-gate #ifdef __cplusplus
33*0Sstevel@tonic-gate extern "C" {
34*0Sstevel@tonic-gate #endif
35*0Sstevel@tonic-gate 
36*0Sstevel@tonic-gate #ifdef	__cplusplus
37*0Sstevel@tonic-gate }
38*0Sstevel@tonic-gate #endif
39*0Sstevel@tonic-gate 
40*0Sstevel@tonic-gate #include "Parser.h"
41*0Sstevel@tonic-gate 
42*0Sstevel@tonic-gate #define	NORMAL_READ 0
43*0Sstevel@tonic-gate #define	ITER_THERE_ONLY 1
44*0Sstevel@tonic-gate 
45*0Sstevel@tonic-gate struct PayloadReader
46*0Sstevel@tonic-gate {
47*0Sstevel@tonic-gate 	// will send the data back in (data,dataLen)
48*0Sstevel@tonic-gate 	static fru_errno_t readData(PathDef *path, Ancestor *curDef,
49*0Sstevel@tonic-gate 				int instWICur,
50*0Sstevel@tonic-gate 				uint8_t *payload, size_t payloadLen,
51*0Sstevel@tonic-gate 				void **data, size_t *dataLen);
52*0Sstevel@tonic-gate 
53*0Sstevel@tonic-gate 	// will update the data in payload which can then be written back.
54*0Sstevel@tonic-gate 	static fru_errno_t updateData(PathDef *path, Ancestor *curDef,
55*0Sstevel@tonic-gate 				int instWICur,
56*0Sstevel@tonic-gate 				uint8_t *payload, size_t payloadLen,
57*0Sstevel@tonic-gate 				void *data, size_t dataLen);
58*0Sstevel@tonic-gate 
59*0Sstevel@tonic-gate 	// will return the nuber of iterations actually there.
60*0Sstevel@tonic-gate 	static fru_errno_t findIterThere(PathDef *path, Ancestor *curDef,
61*0Sstevel@tonic-gate 				int instWICur,
62*0Sstevel@tonic-gate 				uint8_t *payload, size_t payloadLen,
63*0Sstevel@tonic-gate 				int *numThere);
64*0Sstevel@tonic-gate 
65*0Sstevel@tonic-gate private:
66*0Sstevel@tonic-gate 	static int getIterationOffset(uint8_t *iter, int iterLen,
67*0Sstevel@tonic-gate 				PathDef *path, int *rcIterThere,
68*0Sstevel@tonic-gate 				fru_errno_t *err,
69*0Sstevel@tonic-gate 				int onlyFindingIterThereFlag);
70*0Sstevel@tonic-gate 	static int calcOffset(int iterType,
71*0Sstevel@tonic-gate 				uint8_t head, uint8_t tail,
72*0Sstevel@tonic-gate 				uint8_t iterThere, uint8_t iterPoss,
73*0Sstevel@tonic-gate 				size_t length, int index,
74*0Sstevel@tonic-gate 				fru_errno_t *err);
75*0Sstevel@tonic-gate 
76*0Sstevel@tonic-gate 	static fru_errno_t readRecurse(PathDef *path,
77*0Sstevel@tonic-gate 				uint8_t *cur, size_t curLen,
78*0Sstevel@tonic-gate 				void **data, size_t *dataLen,
79*0Sstevel@tonic-gate 				int onlyFindingIterThereFlag);
80*0Sstevel@tonic-gate 
81*0Sstevel@tonic-gate 	static fru_errno_t updateRecurse(PathDef *path,
82*0Sstevel@tonic-gate 				uint8_t *cur, size_t curLen,
83*0Sstevel@tonic-gate 				void *data, size_t dataLen);
84*0Sstevel@tonic-gate 
85*0Sstevel@tonic-gate 	static int getOffsetIntoRecord(fru_regdef_t *recDef,
86*0Sstevel@tonic-gate 				fru_regdef_t *elemDef);
87*0Sstevel@tonic-gate 
88*0Sstevel@tonic-gate 	PayloadReader();
89*0Sstevel@tonic-gate 	~PayloadReader();
90*0Sstevel@tonic-gate 	PayloadReader(const PayloadReader&);
91*0Sstevel@tonic-gate 	void operator=(const PayloadReader&);
92*0Sstevel@tonic-gate };
93*0Sstevel@tonic-gate 
94*0Sstevel@tonic-gate #ifdef __cplusplus
95*0Sstevel@tonic-gate extern "C" {
96*0Sstevel@tonic-gate #endif
97*0Sstevel@tonic-gate 
98*0Sstevel@tonic-gate #ifdef	__cplusplus
99*0Sstevel@tonic-gate }
100*0Sstevel@tonic-gate #endif
101*0Sstevel@tonic-gate 
102*0Sstevel@tonic-gate #endif /* _PAYLOADREADER_H */
103