2 * Copyright (C) 1995 Advanced RISC Machines Limited. All rights reserved.
4 * This software may be freely used, copied, modified, and distributed
5 * provided that the above copyright notice is preserved in all copies of the
17 * Title: Parameter negotiation structures and utilities
20 #ifndef angel_params_h
21 #define angel_params_h
30 /* A single parameter, with tag */
31 typedef struct Parameter
{
36 /* A list of parameter values, with tag */
37 typedef struct ParameterList
{
39 unsigned int num_options
;
40 unsigned int *option
; /* points to array of values */
43 /* A configuration of one or more parameters */
44 typedef struct ParameterConfig
{
45 unsigned int num_parameters
;
46 Parameter
*param
; /* pointer to array of Parameters */
49 /* A set of parameter options */
50 typedef struct ParameterOptions
{
51 unsigned int num_param_lists
;
52 ParameterList
*param_list
; /* pointer to array of ParamLists */
56 * Function: Angel_MatchParams
57 * Purpose: find a configuration from the requested options which is
58 * the best match from the supported options.
61 * Input: requested The offered set of parameters.
62 * supported The supported set of parameters.
64 * Returns: ptr to config A match has been made, ptr to result
65 * will remain valid until next call to
67 * NULL Match not possible
69 const ParameterConfig
*Angel_MatchParams( const ParameterOptions
*requested
,
70 const ParameterOptions
*supported
);
73 * Function: Angel_FindParam
74 * Purpose: find the value of a given parameter from a config.
77 * Input: type parameter type to find
78 * config config to search
79 * Output: value parameter value if found
81 * Returns: TRUE parameter found
82 * FALSE parameter not found
84 bool Angel_FindParam( ADP_Parameter type
,
85 const ParameterConfig
*config
,
86 unsigned int *value
);
89 * Function: Angel_StoreParam
90 * Purpose: store the value of a given parameter in a config.
93 * In/Out: config config to store in
94 * Input: type parameter type to store
95 * value parameter value if found
97 * Returns: TRUE parameter found and new value stored
98 * FALSE parameter not found
100 bool Angel_StoreParam( ParameterConfig
*config
,
102 unsigned int value
);
105 * Function: Angel_FindParamList
106 * Purpose: find the parameter list of a given parameter from an options.
109 * Input: type parameter type to find
110 * options options block to search
112 * Returns: pointer to list
113 * NULL parameter not found
115 ParameterList
*Angel_FindParamList( const ParameterOptions
*options
,
116 ADP_Parameter type
);
119 * Function: Angel_BuildParamConfigMessage
120 * Purpose: write a parameter config to a buffer in ADP format.
123 * Input: buffer where to write to
124 * config the parameter config to write
126 * Returns: number of characters written to buffer
128 unsigned int Angel_BuildParamConfigMessage( unsigned char *buffer
,
129 const ParameterConfig
*config
);
132 * Function: Angel_BuildParamOptionsMessage
133 * Purpose: write a parameter Options to a buffer in ADP format.
136 * Input: buffer where to write to
137 * options the options block to write
139 * Returns: number of characters written to buffer
141 unsigned int Angel_BuildParamOptionsMessage( unsigned char *buffer
,
142 const ParameterOptions
*options
);
145 * Function: Angel_ReadParamConfigMessage
146 * Purpose: read a parameter config from a buffer where it is in ADP format.
149 * Input: buffer where to read from
150 * In/Out: config the parameter config to read to, which must
151 * be set up on entry with a valid array, and
152 * the size of the array in num_parameters.
155 * FALSE not enough space in config
157 bool Angel_ReadParamConfigMessage( const unsigned char *buffer
,
158 ParameterConfig
*config
);
161 * Function: Angel_ReadParamOptionsMessage
162 * Purpose: read a parameter options from a buffer
163 * where it is in ADP format.
166 * Input: buffer where to read from
167 * In/Out: options the parameter options block to read to,
168 * which must be set up on entry with a valid
169 * array, and the size of the array in
170 * num_parameters. Each param_list must
171 * also be set up in the same way.
174 * FALSE not enough space in options
176 bool Angel_ReadParamOptionsMessage( const unsigned char *buffer
,
177 ParameterOptions
*options
);
179 #endif /* ndef angel_params_h */
This page took 0.03183 seconds and 4 git commands to generate.