1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
|
/**
* @file amec_parm.h
* @brief Header file for AMEC Parameter interface.
*
*
*/
/**
* @page ChangeLogs Change Logs
* @section _amec_parm_h amec_parm.h
* @verbatim
*
* Flag Def/Fea Userid Date Description
* -------- ---------- -------- --------- ----------------------------------
* @cl002 903552 lefurgy 08/02/2013 Created
* @gs018 907196 gjsilva 11/20/2013 Base support for soft frequency boundaries
* @gs027 918066 gjsilva 03/12/2014 Misc functions from ARL
*
* @endverbatim
*/
/*
This interface takes named memory objects (such as global variables)
and makes them accessible to Amester parameter for reading and
writing. Any memory location may become an Amester parameter.
To add a parameter,
1. Add a new parameter id number in the AMEC_PARM_ENUM below.
2. In the same position, add the parameter to g_amec_parm_list in
amec_parm_table.c
There are macros that help in adding a parameter to the table.
The macro typically takes a) the parameter id, b) a string name,
and c) a pointer to the memory location.
*/
#ifndef _AMEC_PARM_H
#define _AMEC_PARM_H
//*************************************************************************
// Includes
//*************************************************************************
#include <amec_amester.h>
//*************************************************************************
// Defines/Enums
//*************************************************************************
// List of all parameters
// NOTE: The parameters must be in the same order as g_amec_parm_list[] in
// amec_parm_table.c
typedef enum
{
PARM_SYS_FMAX,
PARM_SYS_FMIN,
PARM_GPST,
PARM_PSTATE_MHZ,
PARM_FREQ_REASON,
PARM_FREQ_OR,
PARM_FREQ_OR_EN,
PARM_SYS_THRM_SP,
PARM_SYS_THRM_GAIN,
PARM_SYS_THRM_RES,
PARM_SYS_THRM_SPEED,
PARM_SYS_THRM_FREQ,
PARM_SOFT_FMIN,
PARM_SOFT_FMAX,
PARM_TOD,
AMEC_PARM_NUMBER_OF_PARAMETERS
} AMEC_PARM_ENUM;
typedef enum
{
AMEC_PARM_TYPE_UINT8 = 0,
AMEC_PARM_TYPE_UINT16,
AMEC_PARM_TYPE_UINT32,
AMEC_PARM_TYPE_UINT64,
AMEC_PARM_TYPE_INT8,
AMEC_PARM_TYPE_INT16,
AMEC_PARM_TYPE_INT32,
AMEC_PARM_TYPE_INT64,
AMEC_PARM_TYPE_STRING,
AMEC_PARM_TYPE_RAW
} AMEC_PARM_TYPE_ENUM;
#define AMEC_PARM_MODE_NORMAL (0x00)
#define AMEC_PARM_MODE_READONLY (0x01)
// Length includes null byte terminator. 15 readable characters are allowed.
#define AMEC_PARM_NAME_LENGTH 16
typedef struct amec_parm_s
{
/// name of parameter
CHAR name[AMEC_PARM_NAME_LENGTH];
/// value_ptr: pointer to data
UINT8 *value_ptr;
/// number of bytes in base data
UINT32 length;
/// vector_length is the number of items in the array pointed by value ptr.
UINT32 vector_length;
/// Type of data
UINT8 type : 4;
/// Mode of data (read-write, read-only, etc.)
UINT8 mode : 1;
/// If preread is 1, call amec_parm_preread(GUID) before reading parameter value.
UINT8 preread : 1;
/// If postwrite is 1, call amec_parm_postwrite(GUID) before reading parameter value.
UINT8 postwrite : 1;
} amec_parm_t;
typedef UINT16 AMEC_PARM_GUID;
extern amec_parm_t g_amec_parm_list[];
/*******************************************************************/
/* Function Definitions */
/*******************************************************************/
/**
* @brief Get number of parameters
* @param i_psMsg IPMI command
* @param o_pu8Resp Response string
* @param o_pu8RespLength Response string length
* @param o_retval Command response error code (=0 pass)
*
* Return number of parameters tracked by TPMD
*
*/
void amec_parm_get_number(const IPMIMsg_t *i_psMsg,
UINT8 *o_pu8Resp,
UINT16 *o_pu16RespLength,
UINT8 *o_retval);
/**
* @brief Get parameter configuration (names, types, size, etc.)
* @param i_psMsg IPMI command
* @param o_pu8Resp Response string
* @param o_pu8RespLength Response string length
* @param o_retval Command response error code (=0 pass)
*
* Get the configuration of the parameters (names, size, type, etc.)
*
*/
void amec_parm_get_config(const IPMIMsg_t *i_psMsg,
UINT8 *o_pu8Resp,
UINT16 *o_pu16RespLength,
UINT8 *o_retval);
/**
* @brief Get parameter value
* @param i_psMsg IPMI command
* @param o_pu8Resp Response string
* @param o_pu8RespLength Response string length
* @param o_retval Command response error code (=0 pass)
*
* Read a parameter value
*
*/
void amec_parm_read(const IPMIMsg_t *const i_psMsg,
UINT8 *const o_pu8Resp,
UINT16 *const o_pu16RespLength,
UINT8 *const o_retval);
/**
* @brief Set a parameter value
* @param i_psMsg IPMI command
* @param o_pu8Resp Response string
* @param o_pu8RespLength Response string length
* @param o_retval Command response error code (=0 pass)
*
* Write a value to a parameter
*
*/
void amec_parm_write(const IPMIMsg_t *const i_psMsg,
UINT8 *const o_pu8Resp,
UINT16 *const o_pu16RespLength,
UINT8 *const o_retval);
/**
* @brief Update parameter value before reading
* @param i_parm_guid The parameter number
*
* Some parameters need to be updated before reading.
* For example, a parameter that points to double-buffered
* that may be at a new memory location each time the
* parameter is examined.
* This routine only needs to be called when the parameter
* has a 'preread' field with a value of 1.
*/
void amec_parm_preread(AMEC_PARM_GUID i_parm_guid);
/**
* @brief Update parameter value before reading
* @param i_parm_guid The parameter number
*
* Some parameters trigger actions after writing.
* This routine only needs to be called when the parameter
* has been written and has a 'postwrite' field with a value of 1.
*/
void amec_parm_postwrite(AMEC_PARM_GUID i_parm_guid);
#endif
|
