| 1 |
/*========================== begin_copyright_notice ============================ |
| 2 |
|
| 3 |
Copyright (C) 2017-2021 Intel Corporation |
| 4 |
|
| 5 |
SPDX-License-Identifier: MIT |
| 6 |
|
| 7 |
============================= end_copyright_notice ===========================*/ |
| 8 |
|
| 9 |
/* |
| 10 |
* !!! DO NOT EDIT THIS FILE !!! |
| 11 |
* |
| 12 |
* This file was automagically crafted by GED's model parser. |
| 13 |
*/ |
| 14 |
|
| 15 |
|
| 16 |
#ifndef GED_H |
| 17 |
#define GED_H |
| 18 |
|
| 19 |
|
| 20 |
#ifndef GED_VALIDATION_API |
| 21 |
#define GED_VALIDATION_API 0 |
| 22 |
#endif // GED_VALIDATION_API |
| 23 |
|
| 24 |
#ifndef GED_EXPERIMENTAL |
| 25 |
#define GED_EXPERIMENTAL 0 |
| 26 |
#endif // GED_EXPERIMENTAL |
| 27 |
|
| 28 |
#ifndef GED_CALLCONV |
| 29 |
#define GED_CALLCONV |
| 30 |
#endif // GED_CALLCONV |
| 31 |
#include "ged_basic_types.h" |
| 32 |
#include "ged_enum_types.h" |
| 33 |
#include "ged_ins_field.h" |
| 34 |
#include "ged_enumerations.h" |
| 35 |
|
| 36 |
/*! |
| 37 |
* This is an opaque type for holding a GED instruction. The data should be accessed using the APIs supplied in this header. Before |
| 38 |
* using a ged_ins_t object, one of @ref GED_DecodeIns or @ref GED_InitEmptyIns must be called. Calling any other function will result |
| 39 |
* in undefined behavior. |
| 40 |
*/ |
| 41 |
typedef struct |
| 42 |
{ |
| 43 |
char _dummy[40]; // dummy, do not access directly |
| 44 |
} ged_ins_t; |
| 45 |
|
| 46 |
/*! |
| 47 |
* This enumeration holds the models supported by GED. |
| 48 |
*/ |
| 49 |
typedef enum |
| 50 |
{ |
| 51 |
|
| 52 |
/*! |
| 53 |
* GED Model Version: none |
| 54 |
* Supported CPUs: none |
| 55 |
*/ |
| 56 |
GED_MODEL_NONE, |
| 57 |
|
| 58 |
/*! |
| 59 |
* GED Model Version: 7 |
| 60 |
* Supported CPUs: ivb |
| 61 |
*/ |
| 62 |
GED_MODEL_7, |
| 63 |
|
| 64 |
/*! |
| 65 |
* GED Model Version: 7.5 |
| 66 |
* Supported CPUs: hsw |
| 67 |
*/ |
| 68 |
GED_MODEL_7_5, |
| 69 |
|
| 70 |
/*! |
| 71 |
* GED Model Version: 8 |
| 72 |
* Supported CPUs: bdw |
| 73 |
*/ |
| 74 |
GED_MODEL_8, |
| 75 |
|
| 76 |
/*! |
| 77 |
* GED Model Version: 8.1 |
| 78 |
* Supported CPUs: chv |
| 79 |
*/ |
| 80 |
GED_MODEL_8_1, |
| 81 |
|
| 82 |
/*! |
| 83 |
* GED Model Version: 9 |
| 84 |
* Supported CPUs: skl |
| 85 |
*/ |
| 86 |
GED_MODEL_9, |
| 87 |
|
| 88 |
/*! |
| 89 |
* GED Model Version: 10 |
| 90 |
* Supported CPUs: cnl |
| 91 |
*/ |
| 92 |
GED_MODEL_10, |
| 93 |
|
| 94 |
/*! |
| 95 |
* GED Model Version: 11 |
| 96 |
* Supported CPUs: icl |
| 97 |
*/ |
| 98 |
GED_MODEL_11, |
| 99 |
|
| 100 |
/*! |
| 101 |
* GED Model Version: tgl |
| 102 |
* Supported CPUs: DashG |
| 103 |
*/ |
| 104 |
GED_MODEL_TGL, |
| 105 |
|
| 106 |
/*! |
| 107 |
* GED Model Version: xe.hp |
| 108 |
* Supported CPUs: XeHP |
| 109 |
*/ |
| 110 |
GED_MODEL_XE_HP, |
| 111 |
|
| 112 |
/*! |
| 113 |
* GED Model Version: xe.hpg |
| 114 |
* Supported CPUs: XeHPG |
| 115 |
*/ |
| 116 |
GED_MODEL_XE_HPG, |
| 117 |
|
| 118 |
/*! |
| 119 |
* GED Model Version: xe.hpc.a |
| 120 |
* Supported CPUs: XeHpcA |
| 121 |
*/ |
| 122 |
GED_MODEL_XE_HPC_A, |
| 123 |
|
| 124 |
/*! |
| 125 |
* GED Model Version: xe.hpc |
| 126 |
* Supported CPUs: XeHpc |
| 127 |
*/ |
| 128 |
GED_MODEL_XE_HPC, |
| 129 |
|
| 130 |
/*! |
| 131 |
* GED Model Version: xe.lpg.md |
| 132 |
* Supported CPUs: Xe_LPG_MD |
| 133 |
*/ |
| 134 |
GED_MODEL_XE_LPG_MD, |
| 135 |
|
| 136 |
/*! |
| 137 |
* GED Model Version: xe2 |
| 138 |
* Supported CPUs: Xe2 |
| 139 |
*/ |
| 140 |
GED_MODEL_XE2, |
| 141 |
|
| 142 |
/*! |
| 143 |
* GED Model Version: xe3 |
| 144 |
* Supported CPUs: Xe3 |
| 145 |
*/ |
| 146 |
GED_MODEL_XE3, |
| 147 |
|
| 148 |
/*! |
| 149 |
* GED Model Version: xe3p.cri |
| 150 |
* Supported CPUs: XE3P_CRI |
| 151 |
*/ |
| 152 |
GED_MODEL_XE3P_CRI, |
| 153 |
GED_MODEL_INVALID |
| 154 |
} GED_MODEL; |
| 155 |
|
| 156 |
/*! |
| 157 |
* Get the GED model version (in string form) for the given GED_MODEL Id. |
| 158 |
* If the Id is not valid, return an empty string |
| 159 |
* |
| 160 |
* @param[in] model The GED model. |
| 161 |
* |
| 162 |
* @return The requested string, otherwise an empty string. |
| 163 |
*/ |
| 164 |
extern const char* GED_CALLCONV GED_GetModelVersionString(GED_MODEL model); |
| 165 |
|
| 166 |
#ifdef __cplusplus |
| 167 |
extern "C" |
| 168 |
{ |
| 169 |
#endif // __cplusplus |
| 170 |
|
| 171 |
/*! |
| 172 |
* Get the string representation for the given GED_RETURN_VALUE enumerator. |
| 173 |
* If the value is not valid, return an empty string |
| 174 |
* |
| 175 |
* @param[in] returnValue The given GED_RETURN_VALUE enumerator. |
| 176 |
* |
| 177 |
* @return The requested string. |
| 178 |
*/ |
| 179 |
extern const char* GED_CALLCONV GED_GetReturnValueString(GED_RETURN_VALUE returnValue); |
| 180 |
|
| 181 |
/*! |
| 182 |
* Get the padding of the GED_RETURN_VALUE enum's string representation in order for it to be aligned column-wise. |
| 183 |
* If the value is not valid, return an empty string |
| 184 |
* |
| 185 |
* @param[in] returnValue The given GED_RETURN_VALUE enumerator. |
| 186 |
* |
| 187 |
* @return The requested pad. |
| 188 |
*/ |
| 189 |
extern const char* GED_CALLCONV GED_GetReturnValuePad(GED_RETURN_VALUE returnValue); |
| 190 |
|
| 191 |
/*! |
| 192 |
* Initialize an empty ged_ins_t object and set its opcode. Can be called to initialize a newly allocated object or to clear an |
| 193 |
* existing one. Typically, this function is used for encoding instructions from scratch. For decoding, one may call @ref |
| 194 |
* GED_DecodeIns directly without calling this function first. |
| 195 |
* |
| 196 |
* @param[in] modelId The GED model for the instruction. |
| 197 |
* @param[in,out] ins Pointer to the ged_ins_t object to be initialized. |
| 198 |
* @param[in] opcode The new opcode. |
| 199 |
* |
| 200 |
* @return GED_RETURN_VALUE indicating success or invalid opcode. |
| 201 |
*/ |
| 202 |
extern GED_RETURN_VALUE GED_CALLCONV GED_InitEmptyIns(const GED_MODEL modelId, ged_ins_t* ins, GED_OPCODE opcode); |
| 203 |
|
| 204 |
/*! |
| 205 |
* Decode a single instruction. If the array of raw bytes includes several instructions, only one instruction will be decoded and the |
| 206 |
* remaining bytes will be ignored. |
| 207 |
* |
| 208 |
* @param[in] modelId The GED model for the instruction. |
| 209 |
* @param[in] rawBytes An array of size "size" with the raw bytes of the instruction to decode. |
| 210 |
* @param[in] size The number of bytes in the "rawBytes" array. |
| 211 |
* @param[out] ins Pointer in which to store the decoded instruction (must be preallocated by the calling function). |
| 212 |
* |
| 213 |
* @return GED_RETURN_VALUE indicating success or decoding error. |
| 214 |
*/ |
| 215 |
extern GED_RETURN_VALUE GED_CALLCONV GED_DecodeIns(const GED_MODEL modelId, const unsigned char* rawBytes, const uint32_t size, |
| 216 |
ged_ins_t* ins); |
| 217 |
|
| 218 |
/*! |
| 219 |
* Encode the given instruction and store the raw bytes in the given array. If the instruction cannot be encoded as requested, the |
| 220 |
* array will remain unchanged. The array is expected to be preallocated and large enough to hold the requested instruction bytes. One |
| 221 |
* may provide a NULL pointer instead, in which case the encoding operation will occur, validating the instruction, but the encoded |
| 222 |
* bytes will not be stored. |
| 223 |
* |
| 224 |
* @param[in] ins Pointer to the instruction object. |
| 225 |
* @param[in] insType Determine if instruction should be compacted or not. If the instruction does not have a valid compact |
| 226 |
* form, the rawBytes buffer will remain unchanged and error will be returned. |
| 227 |
* @param[out] rawBytes A preallocated buffer in which to store the instruction bytes. The buffer is expected to be large |
| 228 |
* enough to hold the requested instruction bytes. One may pass a NULL pointer, in which case the encoded |
| 229 |
* instruction bytes will not be stored. |
| 230 |
* |
| 231 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 232 |
*/ |
| 233 |
extern GED_RETURN_VALUE GED_CALLCONV GED_EncodeIns(ged_ins_t* ins, const GED_INS_TYPE insType, unsigned char* rawBytes); |
| 234 |
|
| 235 |
/*! |
| 236 |
* Get the size (in bytes) of the given instruction. See @ref GED_IsCompact for details. |
| 237 |
* |
| 238 |
* @param[in] ins Pointer to the instruction object. |
| 239 |
* |
| 240 |
* @return The size (in bytes) of the given instruction. |
| 241 |
*/ |
| 242 |
extern uint32_t GED_CALLCONV GED_InsSize(const ged_ins_t* ins); |
| 243 |
|
| 244 |
/*! |
| 245 |
* Check if the given instruction was modified (i.e. on of the instruction field setter APIs was called) since it was last |
| 246 |
* decoded/encoded (i.e. since the last call to @ref GED_DecodeIns or @ref GED_EncodeIns). |
| 247 |
* |
| 248 |
* @param[in] ins Pointer to the instruction object. |
| 249 |
* |
| 250 |
* @return TRUE if the instruction was modified since the last decode/encode operation. |
| 251 |
*/ |
| 252 |
extern bool GED_CALLCONV GED_InsModified(const ged_ins_t* ins); |
| 253 |
|
| 254 |
#if GED_VALIDATION_API |
| 255 |
|
| 256 |
/*! |
| 257 |
* Count the amount of valid compact encodings the instruction has. |
| 258 |
* |
| 259 |
* @param[in] ins Pointer to the instruction object. |
| 260 |
* @param[out] count The number of valid compact encodings the instruction has. If an instruction does not have a valid compact |
| 261 |
* encoding, result is undefined. |
| 262 |
* |
| 263 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 264 |
*/ |
| 265 |
extern GED_RETURN_VALUE GED_CALLCONV GED_CountCompactEncodings(ged_ins_t* ins, unsigned int& count); |
| 266 |
|
| 267 |
/*! |
| 268 |
* Generate all valid compact encodings of the instruction. The buffer is expected to be preallocated and large enough to hold the |
| 269 |
* requested instructions' bytes. Use @ref GED_CountCompactEncodings get the amount of expected compact encodings. |
| 270 |
* |
| 271 |
* @param[in] ins Pointer to the instruction object. |
| 272 |
* @param[in] size The size of the preallocated buffer compactBytesArray, in bytes. |
| 273 |
* @param[out] compactBytesArray A preallocated buffer in which to store the instruction bytes. The buffer is expected to be |
| 274 |
* large enough to hold the requested instructions' bytes. |
| 275 |
* |
| 276 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 277 |
*/ |
| 278 |
extern GED_RETURN_VALUE GED_CALLCONV GED_GetCompactEncodings(ged_ins_t* ins, const unsigned int size, unsigned char* |
| 279 |
compactBytesArray); |
| 280 |
|
| 281 |
/*! |
| 282 |
* Print all bit positions and their mapping of given field in the instruction.If a field is invalid, print accordingly. If a fragment |
| 283 |
* of the field has a fixed value("padded"), print its fixed value |
| 284 |
* |
| 285 |
* @param[in] ins Pointer to the instruction object containing the field in question. |
| 286 |
* @param[in] field The requested field. |
| 287 |
* |
| 288 |
* @return GED_RETURN_VALUE indicating success or decoding error. |
| 289 |
*/ |
| 290 |
extern GED_RETURN_VALUE GED_CALLCONV GED_PrintFieldBitLocation(const ged_ins_t* ins, const GED_INS_FIELD field); |
| 291 |
#endif // GED_VALIDATION_API |
| 292 |
|
| 293 |
/*! |
| 294 |
* Return encoding of field within instruction bytes |
| 295 |
* |
| 296 |
* @param[in] ins Pointer to the instruction object containing the field in question. |
| 297 |
* @param[in] field The requested field. |
| 298 |
* @param[in] fragments Array of fragments. |
| 299 |
* @param[in] length Length of fragments array. |
| 300 |
* |
| 301 |
* @return GED_RETURN_VALUE indicating success or decoding error. |
| 302 |
*/ |
| 303 |
extern GED_RETURN_VALUE GED_CALLCONV GED_QueryFieldBitLocation(const ged_ins_t* ins, const GED_INS_FIELD field, uint32_t * fragments, |
| 304 |
uint32_t * length); |
| 305 |
|
| 306 |
/*! |
| 307 |
* Get the size (in bits) of the given field within the given instruction. If the field is invalid for the given instruction, the |
| 308 |
* function returns 0. |
| 309 |
* |
| 310 |
* @param[in] ins Pointer to the instruction object containing the field in question. |
| 311 |
* @param[in] field The requested field. |
| 312 |
* |
| 313 |
* @return The field's size (in bits) if it is valid, 0 otherwise. |
| 314 |
*/ |
| 315 |
extern uint32_t GED_CALLCONV GED_FieldSize(const ged_ins_t* ins, const GED_INS_FIELD field); |
| 316 |
|
| 317 |
/*! |
| 318 |
* Get the given instruction's opcode. The function returns an enumeration value, use @ref GED_GetMnemonic to obtain the instruction's |
| 319 |
* string mnemonic. |
| 320 |
* |
| 321 |
* @param[in] ins Pointer to the decoded instruction object. |
| 322 |
* |
| 323 |
* @return Opcode enumeration value as defined in ged_enumerations.h. |
| 324 |
*/ |
| 325 |
extern GED_OPCODE GED_CALLCONV GED_GetOpcode(const ged_ins_t* ins); |
| 326 |
|
| 327 |
/*! |
| 328 |
* Get the given instruction's mnemonic. |
| 329 |
* |
| 330 |
* @param[in] ins Pointer to the decoded instruction object. |
| 331 |
* |
| 332 |
* @return String representation of the instruction's mnemonic. |
| 333 |
*/ |
| 334 |
extern const char* GED_CALLCONV GED_GetMnemonic(const ged_ins_t* ins); |
| 335 |
|
| 336 |
/*! |
| 337 |
* Set a new opcode in the given instruction. If the instruction layout changes due to the new opcode, all other bits will be cleared |
| 338 |
* (effectively invalidating all the instruction fields). If the layout does not change, all the other instruction fields' values will |
| 339 |
* remain unchanged. |
| 340 |
* |
| 341 |
* @param[in,out] ins Pointer to the decoded instruction object. |
| 342 |
* @param[in] opcode The new opcode. |
| 343 |
* |
| 344 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 345 |
*/ |
| 346 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetOpcode(ged_ins_t* ins, const GED_OPCODE opcode); |
| 347 |
|
| 348 |
/*! |
| 349 |
* Check if the given instruction is compacted. For decoded instructions it reflects the state of the CmptCtrl bit. For Encoded |
| 350 |
* instructions, it reflects the encoded status. If @ref GED_EncodeIns was successfully called with compact=TRUE then the function |
| 351 |
* will return TRUE. If @ref GED_EncodeIns was successfully called with compact=FALSE, then the function will return FALSE regardless |
| 352 |
* of the validity of the instruction's compact form. This means that even if the instruction can be encoded as compact the function |
| 353 |
* will still return FALSE. If the instruction was modified since it was last decoded/encoded i.e. @ref GED_InsModified returns TRUE, |
| 354 |
* the behavior of this function is undefined and one must call @ref GED_EncodeIns in order to get a the correct result. |
| 355 |
* |
| 356 |
* @param[in] ins Pointer to the decoded instruction object. |
| 357 |
* |
| 358 |
* @return TRUE if the instruction is compacted i.e. in its compact form, FALSE, otherwise. |
| 359 |
*/ |
| 360 |
extern bool GED_CALLCONV GED_IsCompact(const ged_ins_t* ins); |
| 361 |
|
| 362 |
/*! |
| 363 |
* The function returns GED model of the specified instruction. |
| 364 |
* |
| 365 |
* @param[in] ins Pointer to the decoded instruction object. |
| 366 |
* |
| 367 |
* @return Model ID |
| 368 |
*/ |
| 369 |
extern GED_MODEL GED_CALLCONV GED_GetModel(const ged_ins_t* ins); |
| 370 |
|
| 371 |
/*! |
| 372 |
* Get the value of the ___SrcImm field in the given instruction. See @ref GED_INS_FIELD____SrcImm for the field's description. |
| 373 |
* |
| 374 |
* @param[in] ins Pointer to the decoded instruction object. |
| 375 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 376 |
* which caused the failure. |
| 377 |
* |
| 378 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 379 |
* it is important to check the GED_RETURN_VALUE result. |
| 380 |
* |
| 381 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 382 |
*/ |
| 383 |
extern uint32_t GED_CALLCONV GED_Get___SrcImm(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 384 |
|
| 385 |
/*! |
| 386 |
* Set the value of the ___SrcImm field in the given instruction. See @ref GED_INS_FIELD____SrcImm for the field's description. |
| 387 |
* |
| 388 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 389 |
* @param[in] value The value to encode. |
| 390 |
* |
| 391 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 392 |
*/ |
| 393 |
extern GED_RETURN_VALUE GED_CALLCONV GED_Set___SrcImm(ged_ins_t* ins, const uint32_t value); |
| 394 |
|
| 395 |
/*! |
| 396 |
* Get the value of the NumOfSourceOperands field in the given instruction. See @ref GED_INS_FIELD_NumOfSourceOperands for the field's |
| 397 |
* description. |
| 398 |
* |
| 399 |
* @param[in] ins Pointer to the decoded instruction object. |
| 400 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 401 |
* which caused the failure. |
| 402 |
* |
| 403 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 404 |
* it is important to check the GED_RETURN_VALUE result. |
| 405 |
* |
| 406 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 407 |
*/ |
| 408 |
extern uint32_t GED_CALLCONV GED_GetNumOfSourceOperands(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 409 |
|
| 410 |
/*! |
| 411 |
* Get the value of the HasDestinationOperand field in the given instruction. See @ref GED_INS_FIELD_HasDestinationOperand for the |
| 412 |
* field's description. |
| 413 |
* |
| 414 |
* @param[in] ins Pointer to the decoded instruction object. |
| 415 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 416 |
* which caused the failure. |
| 417 |
* |
| 418 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 419 |
* it is important to check the GED_RETURN_VALUE result. |
| 420 |
* |
| 421 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 422 |
*/ |
| 423 |
extern uint32_t GED_CALLCONV GED_GetHasDestinationOperand(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 424 |
|
| 425 |
/*! |
| 426 |
* Get the value of the AccessMode field in the given instruction. The function returns an enumeration value. To obtain the enum |
| 427 |
* entry's string representation, use @ref GED_GetAccessModeString. See @ref GED_INS_FIELD_AccessMode for the field's description. |
| 428 |
* |
| 429 |
* @param[in] ins Pointer to the decoded instruction object. |
| 430 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 431 |
* which caused the failure. |
| 432 |
* |
| 433 |
* @return AccessMode's enumeration if the field is valid, GED_ACCESS_MODE_INVALID otherwise. |
| 434 |
* |
| 435 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 436 |
*/ |
| 437 |
extern GED_ACCESS_MODE GED_CALLCONV GED_GetAccessMode(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 438 |
|
| 439 |
/*! |
| 440 |
* Set the value of the AccessMode field in the given instruction. See @ref GED_INS_FIELD_AccessMode for the field's description. |
| 441 |
* |
| 442 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 443 |
* @param[in] value The value to encode. |
| 444 |
* |
| 445 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 446 |
*/ |
| 447 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetAccessMode(ged_ins_t* ins, const GED_ACCESS_MODE value); |
| 448 |
|
| 449 |
/*! |
| 450 |
* Get the value of the MaskCtrl field in the given instruction. The function returns an enumeration value. To obtain the enum entry's |
| 451 |
* string representation, use @ref GED_GetMaskCtrlString. See @ref GED_INS_FIELD_MaskCtrl for the field's description. |
| 452 |
* |
| 453 |
* @param[in] ins Pointer to the decoded instruction object. |
| 454 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 455 |
* which caused the failure. |
| 456 |
* |
| 457 |
* @return MaskCtrl's enumeration if the field is valid, GED_MASK_CTRL_INVALID otherwise. |
| 458 |
* |
| 459 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 460 |
*/ |
| 461 |
extern GED_MASK_CTRL GED_CALLCONV GED_GetMaskCtrl(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 462 |
|
| 463 |
/*! |
| 464 |
* Set the value of the MaskCtrl field in the given instruction. See @ref GED_INS_FIELD_MaskCtrl for the field's description. |
| 465 |
* |
| 466 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 467 |
* @param[in] value The value to encode. |
| 468 |
* |
| 469 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 470 |
*/ |
| 471 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetMaskCtrl(ged_ins_t* ins, const GED_MASK_CTRL value); |
| 472 |
|
| 473 |
/*! |
| 474 |
* Get the value of the DepCtrl field in the given instruction. The function returns an enumeration value. To obtain the enum entry's |
| 475 |
* string representation, use @ref GED_GetDepCtrlString. See @ref GED_INS_FIELD_DepCtrl for the field's description. |
| 476 |
* |
| 477 |
* @param[in] ins Pointer to the decoded instruction object. |
| 478 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 479 |
* which caused the failure. |
| 480 |
* |
| 481 |
* @return DepCtrl's enumeration if the field is valid, GED_DEP_CTRL_INVALID otherwise. |
| 482 |
* |
| 483 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 484 |
*/ |
| 485 |
extern GED_DEP_CTRL GED_CALLCONV GED_GetDepCtrl(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 486 |
|
| 487 |
/*! |
| 488 |
* Set the value of the DepCtrl field in the given instruction. See @ref GED_INS_FIELD_DepCtrl for the field's description. |
| 489 |
* |
| 490 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 491 |
* @param[in] value The value to encode. |
| 492 |
* |
| 493 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 494 |
*/ |
| 495 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetDepCtrl(ged_ins_t* ins, const GED_DEP_CTRL value); |
| 496 |
|
| 497 |
/*! |
| 498 |
* Get the value of the ExecMaskOffsetCtrl field in the given instruction. The function returns an enumeration value. To obtain the |
| 499 |
* enum entry's string representation, use @ref GED_GetExecMaskOffsetCtrlString. See @ref GED_INS_FIELD_ExecMaskOffsetCtrl for the |
| 500 |
* field's description. |
| 501 |
* |
| 502 |
* @param[in] ins Pointer to the decoded instruction object. |
| 503 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 504 |
* which caused the failure. |
| 505 |
* |
| 506 |
* @return ExecMaskOffsetCtrl's enumeration if the field is valid, GED_EXEC_MASK_OFFSET_CTRL_INVALID otherwise. |
| 507 |
* |
| 508 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 509 |
*/ |
| 510 |
extern GED_EXEC_MASK_OFFSET_CTRL GED_CALLCONV GED_GetExecMaskOffsetCtrl(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 511 |
|
| 512 |
/*! |
| 513 |
* Set the value of the ExecMaskOffsetCtrl field in the given instruction. See @ref GED_INS_FIELD_ExecMaskOffsetCtrl for the field's |
| 514 |
* description. |
| 515 |
* |
| 516 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 517 |
* @param[in] value The value to encode. |
| 518 |
* |
| 519 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 520 |
*/ |
| 521 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetExecMaskOffsetCtrl(ged_ins_t* ins, const GED_EXEC_MASK_OFFSET_CTRL value); |
| 522 |
|
| 523 |
/*! |
| 524 |
* Get the value of the ChannelOffset field in the given instruction. The function returns an enumeration value. To obtain the enum |
| 525 |
* entry's string representation, use @ref GED_GetChannelOffsetString. See @ref GED_INS_FIELD_ChannelOffset for the field's |
| 526 |
* description. |
| 527 |
* |
| 528 |
* @param[in] ins Pointer to the decoded instruction object. |
| 529 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 530 |
* which caused the failure. |
| 531 |
* |
| 532 |
* @return ChannelOffset's enumeration if the field is valid, GED_CHANNEL_OFFSET_INVALID otherwise. |
| 533 |
* |
| 534 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 535 |
*/ |
| 536 |
extern GED_CHANNEL_OFFSET GED_CALLCONV GED_GetChannelOffset(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 537 |
|
| 538 |
/*! |
| 539 |
* Set the value of the ChannelOffset field in the given instruction. See @ref GED_INS_FIELD_ChannelOffset for the field's |
| 540 |
* description. |
| 541 |
* |
| 542 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 543 |
* @param[in] value The value to encode. |
| 544 |
* |
| 545 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 546 |
*/ |
| 547 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetChannelOffset(ged_ins_t* ins, const GED_CHANNEL_OFFSET value); |
| 548 |
|
| 549 |
/*! |
| 550 |
* Get the value of the ThreadCtrl field in the given instruction. The function returns an enumeration value. To obtain the enum |
| 551 |
* entry's string representation, use @ref GED_GetThreadCtrlString. See @ref GED_INS_FIELD_ThreadCtrl for the field's description. |
| 552 |
* |
| 553 |
* @param[in] ins Pointer to the decoded instruction object. |
| 554 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 555 |
* which caused the failure. |
| 556 |
* |
| 557 |
* @return ThreadCtrl's enumeration if the field is valid, GED_THREAD_CTRL_INVALID otherwise. |
| 558 |
* |
| 559 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 560 |
*/ |
| 561 |
extern GED_THREAD_CTRL GED_CALLCONV GED_GetThreadCtrl(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 562 |
|
| 563 |
/*! |
| 564 |
* Set the value of the ThreadCtrl field in the given instruction. See @ref GED_INS_FIELD_ThreadCtrl for the field's description. |
| 565 |
* |
| 566 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 567 |
* @param[in] value The value to encode. |
| 568 |
* |
| 569 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 570 |
*/ |
| 571 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetThreadCtrl(ged_ins_t* ins, const GED_THREAD_CTRL value); |
| 572 |
|
| 573 |
/*! |
| 574 |
* Get the value of the PredCtrl field in the given instruction. The function returns an enumeration value. To obtain the enum entry's |
| 575 |
* string representation, use @ref GED_GetPredCtrlString. See @ref GED_INS_FIELD_PredCtrl for the field's description. |
| 576 |
* |
| 577 |
* @param[in] ins Pointer to the decoded instruction object. |
| 578 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 579 |
* which caused the failure. |
| 580 |
* |
| 581 |
* @return PredCtrl's enumeration if the field is valid, GED_PRED_CTRL_INVALID otherwise. |
| 582 |
* |
| 583 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 584 |
*/ |
| 585 |
extern GED_PRED_CTRL GED_CALLCONV GED_GetPredCtrl(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 586 |
|
| 587 |
/*! |
| 588 |
* Set the value of the PredCtrl field in the given instruction. See @ref GED_INS_FIELD_PredCtrl for the field's description. |
| 589 |
* |
| 590 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 591 |
* @param[in] value The value to encode. |
| 592 |
* |
| 593 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 594 |
*/ |
| 595 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetPredCtrl(ged_ins_t* ins, const GED_PRED_CTRL value); |
| 596 |
|
| 597 |
/*! |
| 598 |
* Get the value of the PredInv field in the given instruction. The function returns an enumeration value. To obtain the enum entry's |
| 599 |
* string representation, use @ref GED_GetPredInvString. See @ref GED_INS_FIELD_PredInv for the field's description. |
| 600 |
* |
| 601 |
* @param[in] ins Pointer to the decoded instruction object. |
| 602 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 603 |
* which caused the failure. |
| 604 |
* |
| 605 |
* @return PredInv's enumeration if the field is valid, GED_PRED_INV_INVALID otherwise. |
| 606 |
* |
| 607 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 608 |
*/ |
| 609 |
extern GED_PRED_INV GED_CALLCONV GED_GetPredInv(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 610 |
|
| 611 |
/*! |
| 612 |
* Set the value of the PredInv field in the given instruction. See @ref GED_INS_FIELD_PredInv for the field's description. |
| 613 |
* |
| 614 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 615 |
* @param[in] value The value to encode. |
| 616 |
* |
| 617 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 618 |
*/ |
| 619 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetPredInv(ged_ins_t* ins, const GED_PRED_INV value); |
| 620 |
|
| 621 |
/*! |
| 622 |
* Get the value of the ExecSize field in the given instruction. See @ref GED_INS_FIELD_ExecSize for the field's description. |
| 623 |
* |
| 624 |
* @param[in] ins Pointer to the decoded instruction object. |
| 625 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 626 |
* which caused the failure. |
| 627 |
* |
| 628 |
* @return The requested value upon success. If the encoded value is not valid, i.e. does not map to any valid enumerated value |
| 629 |
* for this instruction, the (invalid) encoded value is returned. If the field is not valid for the instruction, the |
| 630 |
* uint32_t equivalent of -1 is returned. If -1 is a valid value for this field, it is important to check the |
| 631 |
* GED_RETURN_VALUE result. |
| 632 |
* |
| 633 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 634 |
*/ |
| 635 |
extern uint32_t GED_CALLCONV GED_GetExecSize(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 636 |
|
| 637 |
/*! |
| 638 |
* Set the value of the ExecSize field in the given instruction. See @ref GED_INS_FIELD_ExecSize for the field's description. |
| 639 |
* |
| 640 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 641 |
* @param[in] value The value to encode. |
| 642 |
* |
| 643 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 644 |
*/ |
| 645 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetExecSize(ged_ins_t* ins, const uint32_t value); |
| 646 |
|
| 647 |
/*! |
| 648 |
* Get the value of the CondModifier field in the given instruction. The function returns an enumeration value. To obtain the enum |
| 649 |
* entry's string representation, use @ref GED_GetCondModifierString. See @ref GED_INS_FIELD_CondModifier for the field's description. |
| 650 |
* |
| 651 |
* @param[in] ins Pointer to the decoded instruction object. |
| 652 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 653 |
* which caused the failure. |
| 654 |
* |
| 655 |
* @return CondModifier's enumeration if the field is valid, GED_COND_MODIFIER_INVALID otherwise. |
| 656 |
* |
| 657 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 658 |
*/ |
| 659 |
extern GED_COND_MODIFIER GED_CALLCONV GED_GetCondModifier(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 660 |
|
| 661 |
/*! |
| 662 |
* Set the value of the CondModifier field in the given instruction. See @ref GED_INS_FIELD_CondModifier for the field's description. |
| 663 |
* |
| 664 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 665 |
* @param[in] value The value to encode. |
| 666 |
* |
| 667 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 668 |
*/ |
| 669 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetCondModifier(ged_ins_t* ins, const GED_COND_MODIFIER value); |
| 670 |
|
| 671 |
/*! |
| 672 |
* Get the value of the AccWrCtrl field in the given instruction. The function returns an enumeration value. To obtain the enum |
| 673 |
* entry's string representation, use @ref GED_GetAccWrCtrlString. See @ref GED_INS_FIELD_AccWrCtrl for the field's description. |
| 674 |
* |
| 675 |
* @param[in] ins Pointer to the decoded instruction object. |
| 676 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 677 |
* which caused the failure. |
| 678 |
* |
| 679 |
* @return AccWrCtrl's enumeration if the field is valid, GED_ACC_WR_CTRL_INVALID otherwise. |
| 680 |
* |
| 681 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 682 |
*/ |
| 683 |
extern GED_ACC_WR_CTRL GED_CALLCONV GED_GetAccWrCtrl(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 684 |
|
| 685 |
/*! |
| 686 |
* Set the value of the AccWrCtrl field in the given instruction. See @ref GED_INS_FIELD_AccWrCtrl for the field's description. |
| 687 |
* |
| 688 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 689 |
* @param[in] value The value to encode. |
| 690 |
* |
| 691 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 692 |
*/ |
| 693 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetAccWrCtrl(ged_ins_t* ins, const GED_ACC_WR_CTRL value); |
| 694 |
|
| 695 |
/*! |
| 696 |
* Get the value of the DebugCtrl field in the given instruction. The function returns an enumeration value. To obtain the enum |
| 697 |
* entry's string representation, use @ref GED_GetDebugCtrlString. See @ref GED_INS_FIELD_DebugCtrl for the field's description. |
| 698 |
* |
| 699 |
* @param[in] ins Pointer to the decoded instruction object. |
| 700 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 701 |
* which caused the failure. |
| 702 |
* |
| 703 |
* @return DebugCtrl's enumeration if the field is valid, GED_DEBUG_CTRL_INVALID otherwise. |
| 704 |
* |
| 705 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 706 |
*/ |
| 707 |
extern GED_DEBUG_CTRL GED_CALLCONV GED_GetDebugCtrl(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 708 |
|
| 709 |
/*! |
| 710 |
* Set the value of the DebugCtrl field in the given instruction. See @ref GED_INS_FIELD_DebugCtrl for the field's description. |
| 711 |
* |
| 712 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 713 |
* @param[in] value The value to encode. |
| 714 |
* |
| 715 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 716 |
*/ |
| 717 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetDebugCtrl(ged_ins_t* ins, const GED_DEBUG_CTRL value); |
| 718 |
|
| 719 |
/*! |
| 720 |
* Get the value of the Saturate field in the given instruction. The function returns an enumeration value. To obtain the enum entry's |
| 721 |
* string representation, use @ref GED_GetSaturateString. See @ref GED_INS_FIELD_Saturate for the field's description. |
| 722 |
* |
| 723 |
* @param[in] ins Pointer to the decoded instruction object. |
| 724 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 725 |
* which caused the failure. |
| 726 |
* |
| 727 |
* @return Saturate's enumeration if the field is valid, GED_SATURATE_INVALID otherwise. |
| 728 |
* |
| 729 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 730 |
*/ |
| 731 |
extern GED_SATURATE GED_CALLCONV GED_GetSaturate(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 732 |
|
| 733 |
/*! |
| 734 |
* Set the value of the Saturate field in the given instruction. See @ref GED_INS_FIELD_Saturate for the field's description. |
| 735 |
* |
| 736 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 737 |
* @param[in] value The value to encode. |
| 738 |
* |
| 739 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 740 |
*/ |
| 741 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSaturate(ged_ins_t* ins, const GED_SATURATE value); |
| 742 |
|
| 743 |
/*! |
| 744 |
* Get the value of the DstRegFile field in the given instruction. The function returns an enumeration value. To obtain the enum |
| 745 |
* entry's string representation, use @ref GED_GetRegFileString. See @ref GED_INS_FIELD_DstRegFile for the field's description. |
| 746 |
* |
| 747 |
* @param[in] ins Pointer to the decoded instruction object. |
| 748 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 749 |
* which caused the failure. |
| 750 |
* |
| 751 |
* @return DstRegFile's enumeration if the field is valid, GED_REG_FILE_INVALID otherwise. |
| 752 |
* |
| 753 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 754 |
*/ |
| 755 |
extern GED_REG_FILE GED_CALLCONV GED_GetDstRegFile(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 756 |
|
| 757 |
/*! |
| 758 |
* Set the value of the DstRegFile field in the given instruction. See @ref GED_INS_FIELD_DstRegFile for the field's description. |
| 759 |
* |
| 760 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 761 |
* @param[in] value The value to encode. |
| 762 |
* |
| 763 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 764 |
*/ |
| 765 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetDstRegFile(ged_ins_t* ins, const GED_REG_FILE value); |
| 766 |
|
| 767 |
/*! |
| 768 |
* Get the value of the DstDataType field in the given instruction. The function returns an enumeration value. To obtain the enum |
| 769 |
* entry's string representation, use @ref GED_GetDataTypeString. See @ref GED_INS_FIELD_DstDataType for the field's description. |
| 770 |
* |
| 771 |
* @param[in] ins Pointer to the decoded instruction object. |
| 772 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 773 |
* which caused the failure. |
| 774 |
* |
| 775 |
* @return DstDataType's enumeration if the field is valid, GED_DATA_TYPE_INVALID otherwise. |
| 776 |
* |
| 777 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 778 |
*/ |
| 779 |
extern GED_DATA_TYPE GED_CALLCONV GED_GetDstDataType(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 780 |
|
| 781 |
/*! |
| 782 |
* Set the value of the DstDataType field in the given instruction. See @ref GED_INS_FIELD_DstDataType for the field's description. |
| 783 |
* |
| 784 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 785 |
* @param[in] value The value to encode. |
| 786 |
* |
| 787 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 788 |
*/ |
| 789 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetDstDataType(ged_ins_t* ins, const GED_DATA_TYPE value); |
| 790 |
|
| 791 |
/*! |
| 792 |
* Get the value of the Src0RegFile field in the given instruction. The function returns an enumeration value. To obtain the enum |
| 793 |
* entry's string representation, use @ref GED_GetRegFileString. See @ref GED_INS_FIELD_Src0RegFile for the field's description. |
| 794 |
* |
| 795 |
* @param[in] ins Pointer to the decoded instruction object. |
| 796 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 797 |
* which caused the failure. |
| 798 |
* |
| 799 |
* @return Src0RegFile's enumeration if the field is valid, GED_REG_FILE_INVALID otherwise. |
| 800 |
* |
| 801 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 802 |
*/ |
| 803 |
extern GED_REG_FILE GED_CALLCONV GED_GetSrc0RegFile(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 804 |
|
| 805 |
/*! |
| 806 |
* Set the value of the Src0RegFile field in the given instruction. See @ref GED_INS_FIELD_Src0RegFile for the field's description. |
| 807 |
* |
| 808 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 809 |
* @param[in] value The value to encode. |
| 810 |
* |
| 811 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 812 |
*/ |
| 813 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSrc0RegFile(ged_ins_t* ins, const GED_REG_FILE value); |
| 814 |
|
| 815 |
/*! |
| 816 |
* Get the value of the Src0DataType field in the given instruction. The function returns an enumeration value. To obtain the enum |
| 817 |
* entry's string representation, use @ref GED_GetDataTypeString. See @ref GED_INS_FIELD_Src0DataType for the field's description. |
| 818 |
* |
| 819 |
* @param[in] ins Pointer to the decoded instruction object. |
| 820 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 821 |
* which caused the failure. |
| 822 |
* |
| 823 |
* @return Src0DataType's enumeration if the field is valid, GED_DATA_TYPE_INVALID otherwise. |
| 824 |
* |
| 825 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 826 |
*/ |
| 827 |
extern GED_DATA_TYPE GED_CALLCONV GED_GetSrc0DataType(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 828 |
|
| 829 |
/*! |
| 830 |
* Set the value of the Src0DataType field in the given instruction. See @ref GED_INS_FIELD_Src0DataType for the field's description. |
| 831 |
* |
| 832 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 833 |
* @param[in] value The value to encode. |
| 834 |
* |
| 835 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 836 |
*/ |
| 837 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSrc0DataType(ged_ins_t* ins, const GED_DATA_TYPE value); |
| 838 |
|
| 839 |
/*! |
| 840 |
* Get the value of the Src1RegFile field in the given instruction. The function returns an enumeration value. To obtain the enum |
| 841 |
* entry's string representation, use @ref GED_GetRegFileString. See @ref GED_INS_FIELD_Src1RegFile for the field's description. |
| 842 |
* |
| 843 |
* @param[in] ins Pointer to the decoded instruction object. |
| 844 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 845 |
* which caused the failure. |
| 846 |
* |
| 847 |
* @return Src1RegFile's enumeration if the field is valid, GED_REG_FILE_INVALID otherwise. |
| 848 |
* |
| 849 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 850 |
*/ |
| 851 |
extern GED_REG_FILE GED_CALLCONV GED_GetSrc1RegFile(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 852 |
|
| 853 |
/*! |
| 854 |
* Set the value of the Src1RegFile field in the given instruction. See @ref GED_INS_FIELD_Src1RegFile for the field's description. |
| 855 |
* |
| 856 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 857 |
* @param[in] value The value to encode. |
| 858 |
* |
| 859 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 860 |
*/ |
| 861 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSrc1RegFile(ged_ins_t* ins, const GED_REG_FILE value); |
| 862 |
|
| 863 |
/*! |
| 864 |
* Get the value of the Src1DataType field in the given instruction. The function returns an enumeration value. To obtain the enum |
| 865 |
* entry's string representation, use @ref GED_GetDataTypeString. See @ref GED_INS_FIELD_Src1DataType for the field's description. |
| 866 |
* |
| 867 |
* @param[in] ins Pointer to the decoded instruction object. |
| 868 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 869 |
* which caused the failure. |
| 870 |
* |
| 871 |
* @return Src1DataType's enumeration if the field is valid, GED_DATA_TYPE_INVALID otherwise. |
| 872 |
* |
| 873 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 874 |
*/ |
| 875 |
extern GED_DATA_TYPE GED_CALLCONV GED_GetSrc1DataType(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 876 |
|
| 877 |
/*! |
| 878 |
* Set the value of the Src1DataType field in the given instruction. See @ref GED_INS_FIELD_Src1DataType for the field's description. |
| 879 |
* |
| 880 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 881 |
* @param[in] value The value to encode. |
| 882 |
* |
| 883 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 884 |
*/ |
| 885 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSrc1DataType(ged_ins_t* ins, const GED_DATA_TYPE value); |
| 886 |
|
| 887 |
/*! |
| 888 |
* Get the value of the DstChanEn field in the given instruction. The function returns an enumeration value. To obtain the enum |
| 889 |
* entry's string representation, use @ref GED_GetDstChanEnString. See @ref GED_INS_FIELD_DstChanEn for the field's description. |
| 890 |
* |
| 891 |
* @param[in] ins Pointer to the decoded instruction object. |
| 892 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 893 |
* which caused the failure. |
| 894 |
* |
| 895 |
* @return DstChanEn's enumeration if the field is valid, GED_DST_CHAN_EN_INVALID otherwise. |
| 896 |
* |
| 897 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 898 |
*/ |
| 899 |
extern GED_DST_CHAN_EN GED_CALLCONV GED_GetDstChanEn(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 900 |
|
| 901 |
/*! |
| 902 |
* Set the value of the DstChanEn field in the given instruction. See @ref GED_INS_FIELD_DstChanEn for the field's description. |
| 903 |
* |
| 904 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 905 |
* @param[in] value The value to encode. |
| 906 |
* |
| 907 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 908 |
*/ |
| 909 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetDstChanEn(ged_ins_t* ins, const GED_DST_CHAN_EN value); |
| 910 |
|
| 911 |
/*! |
| 912 |
* Get the value of the DstSubRegNum field in the given instruction. See @ref GED_INS_FIELD_DstSubRegNum for the field's description. |
| 913 |
* |
| 914 |
* @param[in] ins Pointer to the decoded instruction object. |
| 915 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 916 |
* which caused the failure. |
| 917 |
* |
| 918 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 919 |
* it is important to check the GED_RETURN_VALUE result. |
| 920 |
* |
| 921 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 922 |
*/ |
| 923 |
extern uint32_t GED_CALLCONV GED_GetDstSubRegNum(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 924 |
|
| 925 |
/*! |
| 926 |
* Set the value of the DstSubRegNum field in the given instruction. See @ref GED_INS_FIELD_DstSubRegNum for the field's description. |
| 927 |
* |
| 928 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 929 |
* @param[in] value The value to encode. |
| 930 |
* |
| 931 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 932 |
*/ |
| 933 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetDstSubRegNum(ged_ins_t* ins, const uint32_t value); |
| 934 |
|
| 935 |
/*! |
| 936 |
* Get the value of the DstAddrImm field in the given instruction. See @ref GED_INS_FIELD_DstAddrImm for the field's description. |
| 937 |
* |
| 938 |
* @param[in] ins Pointer to the decoded instruction object. |
| 939 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 940 |
* which caused the failure. |
| 941 |
* |
| 942 |
* @return The requested value if the field is valid, -1 otherwise. If -1 is a valid value for this field, it is important to |
| 943 |
* check the GED_RETURN_VALUE result. |
| 944 |
* |
| 945 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 946 |
*/ |
| 947 |
extern int32_t GED_CALLCONV GED_GetDstAddrImm(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 948 |
|
| 949 |
/*! |
| 950 |
* Set the value of the DstAddrImm field in the given instruction. See @ref GED_INS_FIELD_DstAddrImm for the field's description. |
| 951 |
* |
| 952 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 953 |
* @param[in] value The value to encode. |
| 954 |
* |
| 955 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 956 |
*/ |
| 957 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetDstAddrImm(ged_ins_t* ins, const int32_t value); |
| 958 |
|
| 959 |
/*! |
| 960 |
* Get the value of the DstRegNum field in the given instruction. See @ref GED_INS_FIELD_DstRegNum for the field's description. |
| 961 |
* |
| 962 |
* @param[in] ins Pointer to the decoded instruction object. |
| 963 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 964 |
* which caused the failure. |
| 965 |
* |
| 966 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 967 |
* it is important to check the GED_RETURN_VALUE result. |
| 968 |
* |
| 969 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 970 |
*/ |
| 971 |
extern uint32_t GED_CALLCONV GED_GetDstRegNum(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 972 |
|
| 973 |
/*! |
| 974 |
* Set the value of the DstRegNum field in the given instruction. See @ref GED_INS_FIELD_DstRegNum for the field's description. |
| 975 |
* |
| 976 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 977 |
* @param[in] value The value to encode. |
| 978 |
* |
| 979 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 980 |
*/ |
| 981 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetDstRegNum(ged_ins_t* ins, const uint32_t value); |
| 982 |
|
| 983 |
/*! |
| 984 |
* Get the value of the DstAddrSubRegNum field in the given instruction. See @ref GED_INS_FIELD_DstAddrSubRegNum for the field's |
| 985 |
* description. |
| 986 |
* |
| 987 |
* @param[in] ins Pointer to the decoded instruction object. |
| 988 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 989 |
* which caused the failure. |
| 990 |
* |
| 991 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 992 |
* it is important to check the GED_RETURN_VALUE result. |
| 993 |
* |
| 994 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 995 |
*/ |
| 996 |
extern uint32_t GED_CALLCONV GED_GetDstAddrSubRegNum(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 997 |
|
| 998 |
/*! |
| 999 |
* Set the value of the DstAddrSubRegNum field in the given instruction. See @ref GED_INS_FIELD_DstAddrSubRegNum for the field's |
| 1000 |
* description. |
| 1001 |
* |
| 1002 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 1003 |
* @param[in] value The value to encode. |
| 1004 |
* |
| 1005 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 1006 |
*/ |
| 1007 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetDstAddrSubRegNum(ged_ins_t* ins, const uint32_t value); |
| 1008 |
|
| 1009 |
/*! |
| 1010 |
* Get the value of the DstHorzStride field in the given instruction. See @ref GED_INS_FIELD_DstHorzStride for the field's |
| 1011 |
* description. |
| 1012 |
* |
| 1013 |
* @param[in] ins Pointer to the decoded instruction object. |
| 1014 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 1015 |
* which caused the failure. |
| 1016 |
* |
| 1017 |
* @return The requested value upon success. If the encoded value is not valid, i.e. does not map to any valid enumerated value |
| 1018 |
* for this instruction, the (invalid) encoded value is returned. If the field is not valid for the instruction, the |
| 1019 |
* uint32_t equivalent of -1 is returned. If -1 is a valid value for this field, it is important to check the |
| 1020 |
* GED_RETURN_VALUE result. |
| 1021 |
* |
| 1022 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 1023 |
*/ |
| 1024 |
extern uint32_t GED_CALLCONV GED_GetDstHorzStride(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 1025 |
|
| 1026 |
/*! |
| 1027 |
* Set the value of the DstHorzStride field in the given instruction. See @ref GED_INS_FIELD_DstHorzStride for the field's |
| 1028 |
* description. |
| 1029 |
* |
| 1030 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 1031 |
* @param[in] value The value to encode. |
| 1032 |
* |
| 1033 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 1034 |
*/ |
| 1035 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetDstHorzStride(ged_ins_t* ins, const uint32_t value); |
| 1036 |
|
| 1037 |
/*! |
| 1038 |
* Get the value of the DstAddrMode field in the given instruction. The function returns an enumeration value. To obtain the enum |
| 1039 |
* entry's string representation, use @ref GED_GetAddrModeString. See @ref GED_INS_FIELD_DstAddrMode for the field's description. |
| 1040 |
* |
| 1041 |
* @param[in] ins Pointer to the decoded instruction object. |
| 1042 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 1043 |
* which caused the failure. |
| 1044 |
* |
| 1045 |
* @return DstAddrMode's enumeration if the field is valid, GED_ADDR_MODE_INVALID otherwise. |
| 1046 |
* |
| 1047 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 1048 |
*/ |
| 1049 |
extern GED_ADDR_MODE GED_CALLCONV GED_GetDstAddrMode(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 1050 |
|
| 1051 |
/*! |
| 1052 |
* Set the value of the DstAddrMode field in the given instruction. See @ref GED_INS_FIELD_DstAddrMode for the field's description. |
| 1053 |
* |
| 1054 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 1055 |
* @param[in] value The value to encode. |
| 1056 |
* |
| 1057 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 1058 |
*/ |
| 1059 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetDstAddrMode(ged_ins_t* ins, const GED_ADDR_MODE value); |
| 1060 |
|
| 1061 |
/*! |
| 1062 |
* Get the value of the Src0ChanSel field in the given instruction. See @ref GED_INS_FIELD_Src0ChanSel for the field's description. |
| 1063 |
* |
| 1064 |
* @param[in] ins Pointer to the decoded instruction object. |
| 1065 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 1066 |
* which caused the failure. |
| 1067 |
* |
| 1068 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 1069 |
* it is important to check the GED_RETURN_VALUE result. |
| 1070 |
* |
| 1071 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 1072 |
*/ |
| 1073 |
extern uint32_t GED_CALLCONV GED_GetSrc0ChanSel(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 1074 |
|
| 1075 |
/*! |
| 1076 |
* Set the value of the Src0ChanSel field in the given instruction. See @ref GED_INS_FIELD_Src0ChanSel for the field's description. |
| 1077 |
* |
| 1078 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 1079 |
* @param[in] value The value to encode. |
| 1080 |
* |
| 1081 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 1082 |
*/ |
| 1083 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSrc0ChanSel(ged_ins_t* ins, const uint32_t value); |
| 1084 |
|
| 1085 |
/*! |
| 1086 |
* Get the value of the Src0SubRegNum field in the given instruction. See @ref GED_INS_FIELD_Src0SubRegNum for the field's |
| 1087 |
* description. |
| 1088 |
* |
| 1089 |
* @param[in] ins Pointer to the decoded instruction object. |
| 1090 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 1091 |
* which caused the failure. |
| 1092 |
* |
| 1093 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 1094 |
* it is important to check the GED_RETURN_VALUE result. |
| 1095 |
* |
| 1096 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 1097 |
*/ |
| 1098 |
extern uint32_t GED_CALLCONV GED_GetSrc0SubRegNum(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 1099 |
|
| 1100 |
/*! |
| 1101 |
* Set the value of the Src0SubRegNum field in the given instruction. See @ref GED_INS_FIELD_Src0SubRegNum for the field's |
| 1102 |
* description. |
| 1103 |
* |
| 1104 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 1105 |
* @param[in] value The value to encode. |
| 1106 |
* |
| 1107 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 1108 |
*/ |
| 1109 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSrc0SubRegNum(ged_ins_t* ins, const uint32_t value); |
| 1110 |
|
| 1111 |
/*! |
| 1112 |
* Get the value of the Src0AddrImm field in the given instruction. See @ref GED_INS_FIELD_Src0AddrImm for the field's description. |
| 1113 |
* |
| 1114 |
* @param[in] ins Pointer to the decoded instruction object. |
| 1115 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 1116 |
* which caused the failure. |
| 1117 |
* |
| 1118 |
* @return The requested value if the field is valid, -1 otherwise. If -1 is a valid value for this field, it is important to |
| 1119 |
* check the GED_RETURN_VALUE result. |
| 1120 |
* |
| 1121 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 1122 |
*/ |
| 1123 |
extern int32_t GED_CALLCONV GED_GetSrc0AddrImm(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 1124 |
|
| 1125 |
/*! |
| 1126 |
* Set the value of the Src0AddrImm field in the given instruction. See @ref GED_INS_FIELD_Src0AddrImm for the field's description. |
| 1127 |
* |
| 1128 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 1129 |
* @param[in] value The value to encode. |
| 1130 |
* |
| 1131 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 1132 |
*/ |
| 1133 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSrc0AddrImm(ged_ins_t* ins, const int32_t value); |
| 1134 |
|
| 1135 |
/*! |
| 1136 |
* Get the value of the Src0RegNum field in the given instruction. See @ref GED_INS_FIELD_Src0RegNum for the field's description. |
| 1137 |
* |
| 1138 |
* @param[in] ins Pointer to the decoded instruction object. |
| 1139 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 1140 |
* which caused the failure. |
| 1141 |
* |
| 1142 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 1143 |
* it is important to check the GED_RETURN_VALUE result. |
| 1144 |
* |
| 1145 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 1146 |
*/ |
| 1147 |
extern uint32_t GED_CALLCONV GED_GetSrc0RegNum(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 1148 |
|
| 1149 |
/*! |
| 1150 |
* Set the value of the Src0RegNum field in the given instruction. See @ref GED_INS_FIELD_Src0RegNum for the field's description. |
| 1151 |
* |
| 1152 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 1153 |
* @param[in] value The value to encode. |
| 1154 |
* |
| 1155 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 1156 |
*/ |
| 1157 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSrc0RegNum(ged_ins_t* ins, const uint32_t value); |
| 1158 |
|
| 1159 |
/*! |
| 1160 |
* Get the value of the Src0AddrSubRegNum field in the given instruction. See @ref GED_INS_FIELD_Src0AddrSubRegNum for the field's |
| 1161 |
* description. |
| 1162 |
* |
| 1163 |
* @param[in] ins Pointer to the decoded instruction object. |
| 1164 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 1165 |
* which caused the failure. |
| 1166 |
* |
| 1167 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 1168 |
* it is important to check the GED_RETURN_VALUE result. |
| 1169 |
* |
| 1170 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 1171 |
*/ |
| 1172 |
extern uint32_t GED_CALLCONV GED_GetSrc0AddrSubRegNum(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 1173 |
|
| 1174 |
/*! |
| 1175 |
* Set the value of the Src0AddrSubRegNum field in the given instruction. See @ref GED_INS_FIELD_Src0AddrSubRegNum for the field's |
| 1176 |
* description. |
| 1177 |
* |
| 1178 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 1179 |
* @param[in] value The value to encode. |
| 1180 |
* |
| 1181 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 1182 |
*/ |
| 1183 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSrc0AddrSubRegNum(ged_ins_t* ins, const uint32_t value); |
| 1184 |
|
| 1185 |
/*! |
| 1186 |
* Get the value of the Src0SrcMod field in the given instruction. The function returns an enumeration value. To obtain the enum |
| 1187 |
* entry's string representation, use @ref GED_GetSrcModString. See @ref GED_INS_FIELD_Src0SrcMod for the field's description. |
| 1188 |
* |
| 1189 |
* @param[in] ins Pointer to the decoded instruction object. |
| 1190 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 1191 |
* which caused the failure. |
| 1192 |
* |
| 1193 |
* @return Src0SrcMod's enumeration if the field is valid, GED_SRC_MOD_INVALID otherwise. |
| 1194 |
* |
| 1195 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 1196 |
*/ |
| 1197 |
extern GED_SRC_MOD GED_CALLCONV GED_GetSrc0SrcMod(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 1198 |
|
| 1199 |
/*! |
| 1200 |
* Set the value of the Src0SrcMod field in the given instruction. See @ref GED_INS_FIELD_Src0SrcMod for the field's description. |
| 1201 |
* |
| 1202 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 1203 |
* @param[in] value The value to encode. |
| 1204 |
* |
| 1205 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 1206 |
*/ |
| 1207 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSrc0SrcMod(ged_ins_t* ins, const GED_SRC_MOD value); |
| 1208 |
|
| 1209 |
/*! |
| 1210 |
* Get the value of the Src0AddrMode field in the given instruction. The function returns an enumeration value. To obtain the enum |
| 1211 |
* entry's string representation, use @ref GED_GetAddrModeString. See @ref GED_INS_FIELD_Src0AddrMode for the field's description. |
| 1212 |
* |
| 1213 |
* @param[in] ins Pointer to the decoded instruction object. |
| 1214 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 1215 |
* which caused the failure. |
| 1216 |
* |
| 1217 |
* @return Src0AddrMode's enumeration if the field is valid, GED_ADDR_MODE_INVALID otherwise. |
| 1218 |
* |
| 1219 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 1220 |
*/ |
| 1221 |
extern GED_ADDR_MODE GED_CALLCONV GED_GetSrc0AddrMode(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 1222 |
|
| 1223 |
/*! |
| 1224 |
* Set the value of the Src0AddrMode field in the given instruction. See @ref GED_INS_FIELD_Src0AddrMode for the field's description. |
| 1225 |
* |
| 1226 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 1227 |
* @param[in] value The value to encode. |
| 1228 |
* |
| 1229 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 1230 |
*/ |
| 1231 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSrc0AddrMode(ged_ins_t* ins, const GED_ADDR_MODE value); |
| 1232 |
|
| 1233 |
/*! |
| 1234 |
* Get the value of the Src0HorzStride field in the given instruction. See @ref GED_INS_FIELD_Src0HorzStride for the field's |
| 1235 |
* description. |
| 1236 |
* |
| 1237 |
* @param[in] ins Pointer to the decoded instruction object. |
| 1238 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 1239 |
* which caused the failure. |
| 1240 |
* |
| 1241 |
* @return The requested value upon success. If the encoded value is not valid, i.e. does not map to any valid enumerated value |
| 1242 |
* for this instruction, the (invalid) encoded value is returned. If the field is not valid for the instruction, the |
| 1243 |
* uint32_t equivalent of -1 is returned. If -1 is a valid value for this field, it is important to check the |
| 1244 |
* GED_RETURN_VALUE result. |
| 1245 |
* |
| 1246 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 1247 |
*/ |
| 1248 |
extern uint32_t GED_CALLCONV GED_GetSrc0HorzStride(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 1249 |
|
| 1250 |
/*! |
| 1251 |
* Set the value of the Src0HorzStride field in the given instruction. See @ref GED_INS_FIELD_Src0HorzStride for the field's |
| 1252 |
* description. |
| 1253 |
* |
| 1254 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 1255 |
* @param[in] value The value to encode. |
| 1256 |
* |
| 1257 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 1258 |
*/ |
| 1259 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSrc0HorzStride(ged_ins_t* ins, const uint32_t value); |
| 1260 |
|
| 1261 |
/*! |
| 1262 |
* Get the value of the Src0Width field in the given instruction. See @ref GED_INS_FIELD_Src0Width for the field's description. |
| 1263 |
* |
| 1264 |
* @param[in] ins Pointer to the decoded instruction object. |
| 1265 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 1266 |
* which caused the failure. |
| 1267 |
* |
| 1268 |
* @return The requested value upon success. If the encoded value is not valid, i.e. does not map to any valid enumerated value |
| 1269 |
* for this instruction, the (invalid) encoded value is returned. If the field is not valid for the instruction, the |
| 1270 |
* uint32_t equivalent of -1 is returned. If -1 is a valid value for this field, it is important to check the |
| 1271 |
* GED_RETURN_VALUE result. |
| 1272 |
* |
| 1273 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 1274 |
*/ |
| 1275 |
extern uint32_t GED_CALLCONV GED_GetSrc0Width(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 1276 |
|
| 1277 |
/*! |
| 1278 |
* Set the value of the Src0Width field in the given instruction. See @ref GED_INS_FIELD_Src0Width for the field's description. |
| 1279 |
* |
| 1280 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 1281 |
* @param[in] value The value to encode. |
| 1282 |
* |
| 1283 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 1284 |
*/ |
| 1285 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSrc0Width(ged_ins_t* ins, const uint32_t value); |
| 1286 |
|
| 1287 |
/*! |
| 1288 |
* Get the value of the Src0VertStride field in the given instruction. See @ref GED_INS_FIELD_Src0VertStride for the field's |
| 1289 |
* description. |
| 1290 |
* |
| 1291 |
* @param[in] ins Pointer to the decoded instruction object. |
| 1292 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 1293 |
* which caused the failure. |
| 1294 |
* |
| 1295 |
* @return The requested value upon success. If the encoded value is not valid, i.e. does not map to any valid enumerated value |
| 1296 |
* for this instruction, the (invalid) encoded value is returned. If the field is not valid for the instruction, the |
| 1297 |
* uint32_t equivalent of -1 is returned. If -1 is a valid value for this field, it is important to check the |
| 1298 |
* GED_RETURN_VALUE result. |
| 1299 |
* |
| 1300 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 1301 |
*/ |
| 1302 |
extern uint32_t GED_CALLCONV GED_GetSrc0VertStride(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 1303 |
|
| 1304 |
/*! |
| 1305 |
* Set the value of the Src0VertStride field in the given instruction. See @ref GED_INS_FIELD_Src0VertStride for the field's |
| 1306 |
* description. |
| 1307 |
* |
| 1308 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 1309 |
* @param[in] value The value to encode. |
| 1310 |
* |
| 1311 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 1312 |
*/ |
| 1313 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSrc0VertStride(ged_ins_t* ins, const uint32_t value); |
| 1314 |
|
| 1315 |
/*! |
| 1316 |
* Get the value of the FlagSubRegNum field in the given instruction. See @ref GED_INS_FIELD_FlagSubRegNum for the field's |
| 1317 |
* description. |
| 1318 |
* |
| 1319 |
* @param[in] ins Pointer to the decoded instruction object. |
| 1320 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 1321 |
* which caused the failure. |
| 1322 |
* |
| 1323 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 1324 |
* it is important to check the GED_RETURN_VALUE result. |
| 1325 |
* |
| 1326 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 1327 |
*/ |
| 1328 |
extern uint32_t GED_CALLCONV GED_GetFlagSubRegNum(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 1329 |
|
| 1330 |
/*! |
| 1331 |
* Set the value of the FlagSubRegNum field in the given instruction. See @ref GED_INS_FIELD_FlagSubRegNum for the field's |
| 1332 |
* description. |
| 1333 |
* |
| 1334 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 1335 |
* @param[in] value The value to encode. |
| 1336 |
* |
| 1337 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 1338 |
*/ |
| 1339 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetFlagSubRegNum(ged_ins_t* ins, const uint32_t value); |
| 1340 |
|
| 1341 |
/*! |
| 1342 |
* Get the value of the FlagRegNum field in the given instruction. See @ref GED_INS_FIELD_FlagRegNum for the field's description. |
| 1343 |
* |
| 1344 |
* @param[in] ins Pointer to the decoded instruction object. |
| 1345 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 1346 |
* which caused the failure. |
| 1347 |
* |
| 1348 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 1349 |
* it is important to check the GED_RETURN_VALUE result. |
| 1350 |
* |
| 1351 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 1352 |
*/ |
| 1353 |
extern uint32_t GED_CALLCONV GED_GetFlagRegNum(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 1354 |
|
| 1355 |
/*! |
| 1356 |
* Set the value of the FlagRegNum field in the given instruction. See @ref GED_INS_FIELD_FlagRegNum for the field's description. |
| 1357 |
* |
| 1358 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 1359 |
* @param[in] value The value to encode. |
| 1360 |
* |
| 1361 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 1362 |
*/ |
| 1363 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetFlagRegNum(ged_ins_t* ins, const uint32_t value); |
| 1364 |
|
| 1365 |
/*! |
| 1366 |
* Get the value of the Src1ChanSel field in the given instruction. See @ref GED_INS_FIELD_Src1ChanSel for the field's description. |
| 1367 |
* |
| 1368 |
* @param[in] ins Pointer to the decoded instruction object. |
| 1369 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 1370 |
* which caused the failure. |
| 1371 |
* |
| 1372 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 1373 |
* it is important to check the GED_RETURN_VALUE result. |
| 1374 |
* |
| 1375 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 1376 |
*/ |
| 1377 |
extern uint32_t GED_CALLCONV GED_GetSrc1ChanSel(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 1378 |
|
| 1379 |
/*! |
| 1380 |
* Set the value of the Src1ChanSel field in the given instruction. See @ref GED_INS_FIELD_Src1ChanSel for the field's description. |
| 1381 |
* |
| 1382 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 1383 |
* @param[in] value The value to encode. |
| 1384 |
* |
| 1385 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 1386 |
*/ |
| 1387 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSrc1ChanSel(ged_ins_t* ins, const uint32_t value); |
| 1388 |
|
| 1389 |
/*! |
| 1390 |
* Get the value of the Src1SubRegNum field in the given instruction. See @ref GED_INS_FIELD_Src1SubRegNum for the field's |
| 1391 |
* description. |
| 1392 |
* |
| 1393 |
* @param[in] ins Pointer to the decoded instruction object. |
| 1394 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 1395 |
* which caused the failure. |
| 1396 |
* |
| 1397 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 1398 |
* it is important to check the GED_RETURN_VALUE result. |
| 1399 |
* |
| 1400 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 1401 |
*/ |
| 1402 |
extern uint32_t GED_CALLCONV GED_GetSrc1SubRegNum(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 1403 |
|
| 1404 |
/*! |
| 1405 |
* Set the value of the Src1SubRegNum field in the given instruction. See @ref GED_INS_FIELD_Src1SubRegNum for the field's |
| 1406 |
* description. |
| 1407 |
* |
| 1408 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 1409 |
* @param[in] value The value to encode. |
| 1410 |
* |
| 1411 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 1412 |
*/ |
| 1413 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSrc1SubRegNum(ged_ins_t* ins, const uint32_t value); |
| 1414 |
|
| 1415 |
/*! |
| 1416 |
* Get the value of the Src1AddrImm field in the given instruction. See @ref GED_INS_FIELD_Src1AddrImm for the field's description. |
| 1417 |
* |
| 1418 |
* @param[in] ins Pointer to the decoded instruction object. |
| 1419 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 1420 |
* which caused the failure. |
| 1421 |
* |
| 1422 |
* @return The requested value if the field is valid, -1 otherwise. If -1 is a valid value for this field, it is important to |
| 1423 |
* check the GED_RETURN_VALUE result. |
| 1424 |
* |
| 1425 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 1426 |
*/ |
| 1427 |
extern int32_t GED_CALLCONV GED_GetSrc1AddrImm(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 1428 |
|
| 1429 |
/*! |
| 1430 |
* Set the value of the Src1AddrImm field in the given instruction. See @ref GED_INS_FIELD_Src1AddrImm for the field's description. |
| 1431 |
* |
| 1432 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 1433 |
* @param[in] value The value to encode. |
| 1434 |
* |
| 1435 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 1436 |
*/ |
| 1437 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSrc1AddrImm(ged_ins_t* ins, const int32_t value); |
| 1438 |
|
| 1439 |
/*! |
| 1440 |
* Get the value of the Src1RegNum field in the given instruction. See @ref GED_INS_FIELD_Src1RegNum for the field's description. |
| 1441 |
* |
| 1442 |
* @param[in] ins Pointer to the decoded instruction object. |
| 1443 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 1444 |
* which caused the failure. |
| 1445 |
* |
| 1446 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 1447 |
* it is important to check the GED_RETURN_VALUE result. |
| 1448 |
* |
| 1449 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 1450 |
*/ |
| 1451 |
extern uint32_t GED_CALLCONV GED_GetSrc1RegNum(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 1452 |
|
| 1453 |
/*! |
| 1454 |
* Set the value of the Src1RegNum field in the given instruction. See @ref GED_INS_FIELD_Src1RegNum for the field's description. |
| 1455 |
* |
| 1456 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 1457 |
* @param[in] value The value to encode. |
| 1458 |
* |
| 1459 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 1460 |
*/ |
| 1461 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSrc1RegNum(ged_ins_t* ins, const uint32_t value); |
| 1462 |
|
| 1463 |
/*! |
| 1464 |
* Get the value of the Src1AddrSubRegNum field in the given instruction. See @ref GED_INS_FIELD_Src1AddrSubRegNum for the field's |
| 1465 |
* description. |
| 1466 |
* |
| 1467 |
* @param[in] ins Pointer to the decoded instruction object. |
| 1468 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 1469 |
* which caused the failure. |
| 1470 |
* |
| 1471 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 1472 |
* it is important to check the GED_RETURN_VALUE result. |
| 1473 |
* |
| 1474 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 1475 |
*/ |
| 1476 |
extern uint32_t GED_CALLCONV GED_GetSrc1AddrSubRegNum(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 1477 |
|
| 1478 |
/*! |
| 1479 |
* Set the value of the Src1AddrSubRegNum field in the given instruction. See @ref GED_INS_FIELD_Src1AddrSubRegNum for the field's |
| 1480 |
* description. |
| 1481 |
* |
| 1482 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 1483 |
* @param[in] value The value to encode. |
| 1484 |
* |
| 1485 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 1486 |
*/ |
| 1487 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSrc1AddrSubRegNum(ged_ins_t* ins, const uint32_t value); |
| 1488 |
|
| 1489 |
/*! |
| 1490 |
* Get the value of the Src1SrcMod field in the given instruction. The function returns an enumeration value. To obtain the enum |
| 1491 |
* entry's string representation, use @ref GED_GetSrcModString. See @ref GED_INS_FIELD_Src1SrcMod for the field's description. |
| 1492 |
* |
| 1493 |
* @param[in] ins Pointer to the decoded instruction object. |
| 1494 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 1495 |
* which caused the failure. |
| 1496 |
* |
| 1497 |
* @return Src1SrcMod's enumeration if the field is valid, GED_SRC_MOD_INVALID otherwise. |
| 1498 |
* |
| 1499 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 1500 |
*/ |
| 1501 |
extern GED_SRC_MOD GED_CALLCONV GED_GetSrc1SrcMod(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 1502 |
|
| 1503 |
/*! |
| 1504 |
* Set the value of the Src1SrcMod field in the given instruction. See @ref GED_INS_FIELD_Src1SrcMod for the field's description. |
| 1505 |
* |
| 1506 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 1507 |
* @param[in] value The value to encode. |
| 1508 |
* |
| 1509 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 1510 |
*/ |
| 1511 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSrc1SrcMod(ged_ins_t* ins, const GED_SRC_MOD value); |
| 1512 |
|
| 1513 |
/*! |
| 1514 |
* Get the value of the Src1AddrMode field in the given instruction. The function returns an enumeration value. To obtain the enum |
| 1515 |
* entry's string representation, use @ref GED_GetAddrModeString. See @ref GED_INS_FIELD_Src1AddrMode for the field's description. |
| 1516 |
* |
| 1517 |
* @param[in] ins Pointer to the decoded instruction object. |
| 1518 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 1519 |
* which caused the failure. |
| 1520 |
* |
| 1521 |
* @return Src1AddrMode's enumeration if the field is valid, GED_ADDR_MODE_INVALID otherwise. |
| 1522 |
* |
| 1523 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 1524 |
*/ |
| 1525 |
extern GED_ADDR_MODE GED_CALLCONV GED_GetSrc1AddrMode(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 1526 |
|
| 1527 |
/*! |
| 1528 |
* Set the value of the Src1AddrMode field in the given instruction. See @ref GED_INS_FIELD_Src1AddrMode for the field's description. |
| 1529 |
* |
| 1530 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 1531 |
* @param[in] value The value to encode. |
| 1532 |
* |
| 1533 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 1534 |
*/ |
| 1535 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSrc1AddrMode(ged_ins_t* ins, const GED_ADDR_MODE value); |
| 1536 |
|
| 1537 |
/*! |
| 1538 |
* Get the value of the Src1HorzStride field in the given instruction. See @ref GED_INS_FIELD_Src1HorzStride for the field's |
| 1539 |
* description. |
| 1540 |
* |
| 1541 |
* @param[in] ins Pointer to the decoded instruction object. |
| 1542 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 1543 |
* which caused the failure. |
| 1544 |
* |
| 1545 |
* @return The requested value upon success. If the encoded value is not valid, i.e. does not map to any valid enumerated value |
| 1546 |
* for this instruction, the (invalid) encoded value is returned. If the field is not valid for the instruction, the |
| 1547 |
* uint32_t equivalent of -1 is returned. If -1 is a valid value for this field, it is important to check the |
| 1548 |
* GED_RETURN_VALUE result. |
| 1549 |
* |
| 1550 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 1551 |
*/ |
| 1552 |
extern uint32_t GED_CALLCONV GED_GetSrc1HorzStride(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 1553 |
|
| 1554 |
/*! |
| 1555 |
* Set the value of the Src1HorzStride field in the given instruction. See @ref GED_INS_FIELD_Src1HorzStride for the field's |
| 1556 |
* description. |
| 1557 |
* |
| 1558 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 1559 |
* @param[in] value The value to encode. |
| 1560 |
* |
| 1561 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 1562 |
*/ |
| 1563 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSrc1HorzStride(ged_ins_t* ins, const uint32_t value); |
| 1564 |
|
| 1565 |
/*! |
| 1566 |
* Get the value of the Src1Width field in the given instruction. See @ref GED_INS_FIELD_Src1Width for the field's description. |
| 1567 |
* |
| 1568 |
* @param[in] ins Pointer to the decoded instruction object. |
| 1569 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 1570 |
* which caused the failure. |
| 1571 |
* |
| 1572 |
* @return The requested value upon success. If the encoded value is not valid, i.e. does not map to any valid enumerated value |
| 1573 |
* for this instruction, the (invalid) encoded value is returned. If the field is not valid for the instruction, the |
| 1574 |
* uint32_t equivalent of -1 is returned. If -1 is a valid value for this field, it is important to check the |
| 1575 |
* GED_RETURN_VALUE result. |
| 1576 |
* |
| 1577 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 1578 |
*/ |
| 1579 |
extern uint32_t GED_CALLCONV GED_GetSrc1Width(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 1580 |
|
| 1581 |
/*! |
| 1582 |
* Set the value of the Src1Width field in the given instruction. See @ref GED_INS_FIELD_Src1Width for the field's description. |
| 1583 |
* |
| 1584 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 1585 |
* @param[in] value The value to encode. |
| 1586 |
* |
| 1587 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 1588 |
*/ |
| 1589 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSrc1Width(ged_ins_t* ins, const uint32_t value); |
| 1590 |
|
| 1591 |
/*! |
| 1592 |
* Get the value of the Src1VertStride field in the given instruction. See @ref GED_INS_FIELD_Src1VertStride for the field's |
| 1593 |
* description. |
| 1594 |
* |
| 1595 |
* @param[in] ins Pointer to the decoded instruction object. |
| 1596 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 1597 |
* which caused the failure. |
| 1598 |
* |
| 1599 |
* @return The requested value upon success. If the encoded value is not valid, i.e. does not map to any valid enumerated value |
| 1600 |
* for this instruction, the (invalid) encoded value is returned. If the field is not valid for the instruction, the |
| 1601 |
* uint32_t equivalent of -1 is returned. If -1 is a valid value for this field, it is important to check the |
| 1602 |
* GED_RETURN_VALUE result. |
| 1603 |
* |
| 1604 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 1605 |
*/ |
| 1606 |
extern uint32_t GED_CALLCONV GED_GetSrc1VertStride(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 1607 |
|
| 1608 |
/*! |
| 1609 |
* Set the value of the Src1VertStride field in the given instruction. See @ref GED_INS_FIELD_Src1VertStride for the field's |
| 1610 |
* description. |
| 1611 |
* |
| 1612 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 1613 |
* @param[in] value The value to encode. |
| 1614 |
* |
| 1615 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 1616 |
*/ |
| 1617 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSrc1VertStride(ged_ins_t* ins, const uint32_t value); |
| 1618 |
|
| 1619 |
/*! |
| 1620 |
* Get the value of the Imm field in the given instruction. See @ref GED_INS_FIELD_Imm for the field's description. |
| 1621 |
* |
| 1622 |
* @param[in] ins Pointer to the decoded instruction object. |
| 1623 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 1624 |
* which caused the failure. |
| 1625 |
* |
| 1626 |
* @return The requested value if the field is valid, uint64_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 1627 |
* it is important to check the GED_RETURN_VALUE result. |
| 1628 |
* |
| 1629 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 1630 |
*/ |
| 1631 |
extern uint64_t GED_CALLCONV GED_GetImm(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 1632 |
|
| 1633 |
/*! |
| 1634 |
* Set the value of the Imm field in the given instruction. See @ref GED_INS_FIELD_Imm for the field's description. |
| 1635 |
* |
| 1636 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 1637 |
* @param[in] value The value to encode. |
| 1638 |
* |
| 1639 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 1640 |
*/ |
| 1641 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetImm(ged_ins_t* ins, const uint64_t value); |
| 1642 |
|
| 1643 |
/*! |
| 1644 |
* Get the value of the Src2SrcMod field in the given instruction. The function returns an enumeration value. To obtain the enum |
| 1645 |
* entry's string representation, use @ref GED_GetSrcModString. See @ref GED_INS_FIELD_Src2SrcMod for the field's description. |
| 1646 |
* |
| 1647 |
* @param[in] ins Pointer to the decoded instruction object. |
| 1648 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 1649 |
* which caused the failure. |
| 1650 |
* |
| 1651 |
* @return Src2SrcMod's enumeration if the field is valid, GED_SRC_MOD_INVALID otherwise. |
| 1652 |
* |
| 1653 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 1654 |
*/ |
| 1655 |
extern GED_SRC_MOD GED_CALLCONV GED_GetSrc2SrcMod(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 1656 |
|
| 1657 |
/*! |
| 1658 |
* Set the value of the Src2SrcMod field in the given instruction. See @ref GED_INS_FIELD_Src2SrcMod for the field's description. |
| 1659 |
* |
| 1660 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 1661 |
* @param[in] value The value to encode. |
| 1662 |
* |
| 1663 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 1664 |
*/ |
| 1665 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSrc2SrcMod(ged_ins_t* ins, const GED_SRC_MOD value); |
| 1666 |
|
| 1667 |
/*! |
| 1668 |
* Get the value of the SrcDataType field in the given instruction. The function returns an enumeration value. To obtain the enum |
| 1669 |
* entry's string representation, use @ref GED_GetDataTypeString. See @ref GED_INS_FIELD_SrcDataType for the field's description. |
| 1670 |
* |
| 1671 |
* @param[in] ins Pointer to the decoded instruction object. |
| 1672 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 1673 |
* which caused the failure. |
| 1674 |
* |
| 1675 |
* @return SrcDataType's enumeration if the field is valid, GED_DATA_TYPE_INVALID otherwise. |
| 1676 |
* |
| 1677 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 1678 |
*/ |
| 1679 |
extern GED_DATA_TYPE GED_CALLCONV GED_GetSrcDataType(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 1680 |
|
| 1681 |
/*! |
| 1682 |
* Set the value of the SrcDataType field in the given instruction. See @ref GED_INS_FIELD_SrcDataType for the field's description. |
| 1683 |
* |
| 1684 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 1685 |
* @param[in] value The value to encode. |
| 1686 |
* |
| 1687 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 1688 |
*/ |
| 1689 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSrcDataType(ged_ins_t* ins, const GED_DATA_TYPE value); |
| 1690 |
|
| 1691 |
/*! |
| 1692 |
* Get the value of the Src0RepCtrl field in the given instruction. The function returns an enumeration value. To obtain the enum |
| 1693 |
* entry's string representation, use @ref GED_GetRepCtrlString. See @ref GED_INS_FIELD_Src0RepCtrl for the field's description. |
| 1694 |
* |
| 1695 |
* @param[in] ins Pointer to the decoded instruction object. |
| 1696 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 1697 |
* which caused the failure. |
| 1698 |
* |
| 1699 |
* @return Src0RepCtrl's enumeration if the field is valid, GED_REP_CTRL_INVALID otherwise. |
| 1700 |
* |
| 1701 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 1702 |
*/ |
| 1703 |
extern GED_REP_CTRL GED_CALLCONV GED_GetSrc0RepCtrl(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 1704 |
|
| 1705 |
/*! |
| 1706 |
* Set the value of the Src0RepCtrl field in the given instruction. See @ref GED_INS_FIELD_Src0RepCtrl for the field's description. |
| 1707 |
* |
| 1708 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 1709 |
* @param[in] value The value to encode. |
| 1710 |
* |
| 1711 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 1712 |
*/ |
| 1713 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSrc0RepCtrl(ged_ins_t* ins, const GED_REP_CTRL value); |
| 1714 |
|
| 1715 |
/*! |
| 1716 |
* Get the value of the Src1RepCtrl field in the given instruction. The function returns an enumeration value. To obtain the enum |
| 1717 |
* entry's string representation, use @ref GED_GetRepCtrlString. See @ref GED_INS_FIELD_Src1RepCtrl for the field's description. |
| 1718 |
* |
| 1719 |
* @param[in] ins Pointer to the decoded instruction object. |
| 1720 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 1721 |
* which caused the failure. |
| 1722 |
* |
| 1723 |
* @return Src1RepCtrl's enumeration if the field is valid, GED_REP_CTRL_INVALID otherwise. |
| 1724 |
* |
| 1725 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 1726 |
*/ |
| 1727 |
extern GED_REP_CTRL GED_CALLCONV GED_GetSrc1RepCtrl(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 1728 |
|
| 1729 |
/*! |
| 1730 |
* Set the value of the Src1RepCtrl field in the given instruction. See @ref GED_INS_FIELD_Src1RepCtrl for the field's description. |
| 1731 |
* |
| 1732 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 1733 |
* @param[in] value The value to encode. |
| 1734 |
* |
| 1735 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 1736 |
*/ |
| 1737 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSrc1RepCtrl(ged_ins_t* ins, const GED_REP_CTRL value); |
| 1738 |
|
| 1739 |
/*! |
| 1740 |
* Get the value of the Src2RepCtrl field in the given instruction. The function returns an enumeration value. To obtain the enum |
| 1741 |
* entry's string representation, use @ref GED_GetRepCtrlString. See @ref GED_INS_FIELD_Src2RepCtrl for the field's description. |
| 1742 |
* |
| 1743 |
* @param[in] ins Pointer to the decoded instruction object. |
| 1744 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 1745 |
* which caused the failure. |
| 1746 |
* |
| 1747 |
* @return Src2RepCtrl's enumeration if the field is valid, GED_REP_CTRL_INVALID otherwise. |
| 1748 |
* |
| 1749 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 1750 |
*/ |
| 1751 |
extern GED_REP_CTRL GED_CALLCONV GED_GetSrc2RepCtrl(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 1752 |
|
| 1753 |
/*! |
| 1754 |
* Set the value of the Src2RepCtrl field in the given instruction. See @ref GED_INS_FIELD_Src2RepCtrl for the field's description. |
| 1755 |
* |
| 1756 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 1757 |
* @param[in] value The value to encode. |
| 1758 |
* |
| 1759 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 1760 |
*/ |
| 1761 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSrc2RepCtrl(ged_ins_t* ins, const GED_REP_CTRL value); |
| 1762 |
|
| 1763 |
/*! |
| 1764 |
* Get the value of the Src2ChanSel field in the given instruction. See @ref GED_INS_FIELD_Src2ChanSel for the field's description. |
| 1765 |
* |
| 1766 |
* @param[in] ins Pointer to the decoded instruction object. |
| 1767 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 1768 |
* which caused the failure. |
| 1769 |
* |
| 1770 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 1771 |
* it is important to check the GED_RETURN_VALUE result. |
| 1772 |
* |
| 1773 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 1774 |
*/ |
| 1775 |
extern uint32_t GED_CALLCONV GED_GetSrc2ChanSel(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 1776 |
|
| 1777 |
/*! |
| 1778 |
* Set the value of the Src2ChanSel field in the given instruction. See @ref GED_INS_FIELD_Src2ChanSel for the field's description. |
| 1779 |
* |
| 1780 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 1781 |
* @param[in] value The value to encode. |
| 1782 |
* |
| 1783 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 1784 |
*/ |
| 1785 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSrc2ChanSel(ged_ins_t* ins, const uint32_t value); |
| 1786 |
|
| 1787 |
/*! |
| 1788 |
* Get the value of the Src2SubRegNum field in the given instruction. See @ref GED_INS_FIELD_Src2SubRegNum for the field's |
| 1789 |
* description. |
| 1790 |
* |
| 1791 |
* @param[in] ins Pointer to the decoded instruction object. |
| 1792 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 1793 |
* which caused the failure. |
| 1794 |
* |
| 1795 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 1796 |
* it is important to check the GED_RETURN_VALUE result. |
| 1797 |
* |
| 1798 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 1799 |
*/ |
| 1800 |
extern uint32_t GED_CALLCONV GED_GetSrc2SubRegNum(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 1801 |
|
| 1802 |
/*! |
| 1803 |
* Set the value of the Src2SubRegNum field in the given instruction. See @ref GED_INS_FIELD_Src2SubRegNum for the field's |
| 1804 |
* description. |
| 1805 |
* |
| 1806 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 1807 |
* @param[in] value The value to encode. |
| 1808 |
* |
| 1809 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 1810 |
*/ |
| 1811 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSrc2SubRegNum(ged_ins_t* ins, const uint32_t value); |
| 1812 |
|
| 1813 |
/*! |
| 1814 |
* Get the value of the Src2RegNum field in the given instruction. See @ref GED_INS_FIELD_Src2RegNum for the field's description. |
| 1815 |
* |
| 1816 |
* @param[in] ins Pointer to the decoded instruction object. |
| 1817 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 1818 |
* which caused the failure. |
| 1819 |
* |
| 1820 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 1821 |
* it is important to check the GED_RETURN_VALUE result. |
| 1822 |
* |
| 1823 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 1824 |
*/ |
| 1825 |
extern uint32_t GED_CALLCONV GED_GetSrc2RegNum(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 1826 |
|
| 1827 |
/*! |
| 1828 |
* Set the value of the Src2RegNum field in the given instruction. See @ref GED_INS_FIELD_Src2RegNum for the field's description. |
| 1829 |
* |
| 1830 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 1831 |
* @param[in] value The value to encode. |
| 1832 |
* |
| 1833 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 1834 |
*/ |
| 1835 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSrc2RegNum(ged_ins_t* ins, const uint32_t value); |
| 1836 |
|
| 1837 |
/*! |
| 1838 |
* Get the value of the Src2RegFile field in the given instruction. The function returns an enumeration value. To obtain the enum |
| 1839 |
* entry's string representation, use @ref GED_GetRegFileString. See @ref GED_INS_FIELD_Src2RegFile for the field's description. |
| 1840 |
* |
| 1841 |
* @param[in] ins Pointer to the decoded instruction object. |
| 1842 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 1843 |
* which caused the failure. |
| 1844 |
* |
| 1845 |
* @return Src2RegFile's enumeration if the field is valid, GED_REG_FILE_INVALID otherwise. |
| 1846 |
* |
| 1847 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 1848 |
*/ |
| 1849 |
extern GED_REG_FILE GED_CALLCONV GED_GetSrc2RegFile(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 1850 |
|
| 1851 |
/*! |
| 1852 |
* Set the value of the Src2RegFile field in the given instruction. See @ref GED_INS_FIELD_Src2RegFile for the field's description. |
| 1853 |
* |
| 1854 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 1855 |
* @param[in] value The value to encode. |
| 1856 |
* |
| 1857 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 1858 |
*/ |
| 1859 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSrc2RegFile(ged_ins_t* ins, const GED_REG_FILE value); |
| 1860 |
|
| 1861 |
/*! |
| 1862 |
* Get the value of the Src2AddrMode field in the given instruction. The function returns an enumeration value. To obtain the enum |
| 1863 |
* entry's string representation, use @ref GED_GetAddrModeString. See @ref GED_INS_FIELD_Src2AddrMode for the field's description. |
| 1864 |
* |
| 1865 |
* @param[in] ins Pointer to the decoded instruction object. |
| 1866 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 1867 |
* which caused the failure. |
| 1868 |
* |
| 1869 |
* @return Src2AddrMode's enumeration if the field is valid, GED_ADDR_MODE_INVALID otherwise. |
| 1870 |
* |
| 1871 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 1872 |
*/ |
| 1873 |
extern GED_ADDR_MODE GED_CALLCONV GED_GetSrc2AddrMode(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 1874 |
|
| 1875 |
/*! |
| 1876 |
* Set the value of the Src2AddrMode field in the given instruction. See @ref GED_INS_FIELD_Src2AddrMode for the field's description. |
| 1877 |
* |
| 1878 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 1879 |
* @param[in] value The value to encode. |
| 1880 |
* |
| 1881 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 1882 |
*/ |
| 1883 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSrc2AddrMode(ged_ins_t* ins, const GED_ADDR_MODE value); |
| 1884 |
|
| 1885 |
/*! |
| 1886 |
* Get the value of the Src2VertStride field in the given instruction. See @ref GED_INS_FIELD_Src2VertStride for the field's |
| 1887 |
* description. |
| 1888 |
* |
| 1889 |
* @param[in] ins Pointer to the decoded instruction object. |
| 1890 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 1891 |
* which caused the failure. |
| 1892 |
* |
| 1893 |
* @return The requested value upon success. If the encoded value is not valid, i.e. does not map to any valid enumerated value |
| 1894 |
* for this instruction, the (invalid) encoded value is returned. If the field is not valid for the instruction, the |
| 1895 |
* uint32_t equivalent of -1 is returned. If -1 is a valid value for this field, it is important to check the |
| 1896 |
* GED_RETURN_VALUE result. |
| 1897 |
* |
| 1898 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 1899 |
*/ |
| 1900 |
extern uint32_t GED_CALLCONV GED_GetSrc2VertStride(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 1901 |
|
| 1902 |
/*! |
| 1903 |
* Set the value of the Src2VertStride field in the given instruction. See @ref GED_INS_FIELD_Src2VertStride for the field's |
| 1904 |
* description. |
| 1905 |
* |
| 1906 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 1907 |
* @param[in] value The value to encode. |
| 1908 |
* |
| 1909 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 1910 |
*/ |
| 1911 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSrc2VertStride(ged_ins_t* ins, const uint32_t value); |
| 1912 |
|
| 1913 |
/*! |
| 1914 |
* Get the value of the SFID field in the given instruction. The function returns an enumeration value. To obtain the enum entry's |
| 1915 |
* string representation, use @ref GED_GetSFIDString. See @ref GED_INS_FIELD_SFID for the field's description. |
| 1916 |
* |
| 1917 |
* @param[in] ins Pointer to the decoded instruction object. |
| 1918 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 1919 |
* which caused the failure. |
| 1920 |
* |
| 1921 |
* @return SFID's enumeration if the field is valid, GED_SFID_INVALID otherwise. |
| 1922 |
* |
| 1923 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 1924 |
*/ |
| 1925 |
extern GED_SFID GED_CALLCONV GED_GetSFID(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 1926 |
|
| 1927 |
/*! |
| 1928 |
* Set the value of the SFID field in the given instruction. See @ref GED_INS_FIELD_SFID for the field's description. |
| 1929 |
* |
| 1930 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 1931 |
* @param[in] value The value to encode. |
| 1932 |
* |
| 1933 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 1934 |
*/ |
| 1935 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSFID(ged_ins_t* ins, const GED_SFID value); |
| 1936 |
|
| 1937 |
/*! |
| 1938 |
* Get the value of the DescRegFile field in the given instruction. The function returns an enumeration value. To obtain the enum |
| 1939 |
* entry's string representation, use @ref GED_GetRegFileString. See @ref GED_INS_FIELD_DescRegFile for the field's description. |
| 1940 |
* |
| 1941 |
* @param[in] ins Pointer to the decoded instruction object. |
| 1942 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 1943 |
* which caused the failure. |
| 1944 |
* |
| 1945 |
* @return DescRegFile's enumeration if the field is valid, GED_REG_FILE_INVALID otherwise. |
| 1946 |
* |
| 1947 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 1948 |
*/ |
| 1949 |
extern GED_REG_FILE GED_CALLCONV GED_GetDescRegFile(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 1950 |
|
| 1951 |
/*! |
| 1952 |
* Set the value of the DescRegFile field in the given instruction. See @ref GED_INS_FIELD_DescRegFile for the field's description. |
| 1953 |
* |
| 1954 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 1955 |
* @param[in] value The value to encode. |
| 1956 |
* |
| 1957 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 1958 |
*/ |
| 1959 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetDescRegFile(ged_ins_t* ins, const GED_REG_FILE value); |
| 1960 |
|
| 1961 |
/*! |
| 1962 |
* Get the value of the DescDataType field in the given instruction. The function returns an enumeration value. To obtain the enum |
| 1963 |
* entry's string representation, use @ref GED_GetDataTypeString. See @ref GED_INS_FIELD_DescDataType for the field's description. |
| 1964 |
* |
| 1965 |
* @param[in] ins Pointer to the decoded instruction object. |
| 1966 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 1967 |
* which caused the failure. |
| 1968 |
* |
| 1969 |
* @return DescDataType's enumeration if the field is valid, GED_DATA_TYPE_INVALID otherwise. |
| 1970 |
* |
| 1971 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 1972 |
*/ |
| 1973 |
extern GED_DATA_TYPE GED_CALLCONV GED_GetDescDataType(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 1974 |
|
| 1975 |
/*! |
| 1976 |
* Set the value of the DescDataType field in the given instruction. See @ref GED_INS_FIELD_DescDataType for the field's description. |
| 1977 |
* |
| 1978 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 1979 |
* @param[in] value The value to encode. |
| 1980 |
* |
| 1981 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 1982 |
*/ |
| 1983 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetDescDataType(ged_ins_t* ins, const GED_DATA_TYPE value); |
| 1984 |
|
| 1985 |
/*! |
| 1986 |
* Get the value of the DescAddrSubRegNum field in the given instruction. See @ref GED_INS_FIELD_DescAddrSubRegNum for the field's |
| 1987 |
* description. |
| 1988 |
* |
| 1989 |
* @param[in] ins Pointer to the decoded instruction object. |
| 1990 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 1991 |
* which caused the failure. |
| 1992 |
* |
| 1993 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 1994 |
* it is important to check the GED_RETURN_VALUE result. |
| 1995 |
* |
| 1996 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 1997 |
*/ |
| 1998 |
extern uint32_t GED_CALLCONV GED_GetDescAddrSubRegNum(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 1999 |
|
| 2000 |
/*! |
| 2001 |
* Set the value of the DescAddrSubRegNum field in the given instruction. See @ref GED_INS_FIELD_DescAddrSubRegNum for the field's |
| 2002 |
* description. |
| 2003 |
* |
| 2004 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 2005 |
* @param[in] value The value to encode. |
| 2006 |
* |
| 2007 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 2008 |
*/ |
| 2009 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetDescAddrSubRegNum(ged_ins_t* ins, const uint32_t value); |
| 2010 |
|
| 2011 |
/*! |
| 2012 |
* Get the value of the DescRegNum field in the given instruction. See @ref GED_INS_FIELD_DescRegNum for the field's description. |
| 2013 |
* |
| 2014 |
* @param[in] ins Pointer to the decoded instruction object. |
| 2015 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 2016 |
* which caused the failure. |
| 2017 |
* |
| 2018 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 2019 |
* it is important to check the GED_RETURN_VALUE result. |
| 2020 |
* |
| 2021 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 2022 |
*/ |
| 2023 |
extern uint32_t GED_CALLCONV GED_GetDescRegNum(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 2024 |
|
| 2025 |
/*! |
| 2026 |
* Set the value of the DescRegNum field in the given instruction. See @ref GED_INS_FIELD_DescRegNum for the field's description. |
| 2027 |
* |
| 2028 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 2029 |
* @param[in] value The value to encode. |
| 2030 |
* |
| 2031 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 2032 |
*/ |
| 2033 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetDescRegNum(ged_ins_t* ins, const uint32_t value); |
| 2034 |
|
| 2035 |
/*! |
| 2036 |
* Get the value of the DescHorzStride field in the given instruction. See @ref GED_INS_FIELD_DescHorzStride for the field's |
| 2037 |
* description. |
| 2038 |
* |
| 2039 |
* @param[in] ins Pointer to the decoded instruction object. |
| 2040 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 2041 |
* which caused the failure. |
| 2042 |
* |
| 2043 |
* @return The requested value upon success. If the encoded value is not valid, i.e. does not map to any valid enumerated value |
| 2044 |
* for this instruction, the (invalid) encoded value is returned. If the field is not valid for the instruction, the |
| 2045 |
* uint32_t equivalent of -1 is returned. If -1 is a valid value for this field, it is important to check the |
| 2046 |
* GED_RETURN_VALUE result. |
| 2047 |
* |
| 2048 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 2049 |
*/ |
| 2050 |
extern uint32_t GED_CALLCONV GED_GetDescHorzStride(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 2051 |
|
| 2052 |
/*! |
| 2053 |
* Set the value of the DescHorzStride field in the given instruction. See @ref GED_INS_FIELD_DescHorzStride for the field's |
| 2054 |
* description. |
| 2055 |
* |
| 2056 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 2057 |
* @param[in] value The value to encode. |
| 2058 |
* |
| 2059 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 2060 |
*/ |
| 2061 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetDescHorzStride(ged_ins_t* ins, const uint32_t value); |
| 2062 |
|
| 2063 |
/*! |
| 2064 |
* Get the value of the DescWidth field in the given instruction. See @ref GED_INS_FIELD_DescWidth for the field's description. |
| 2065 |
* |
| 2066 |
* @param[in] ins Pointer to the decoded instruction object. |
| 2067 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 2068 |
* which caused the failure. |
| 2069 |
* |
| 2070 |
* @return The requested value upon success. If the encoded value is not valid, i.e. does not map to any valid enumerated value |
| 2071 |
* for this instruction, the (invalid) encoded value is returned. If the field is not valid for the instruction, the |
| 2072 |
* uint32_t equivalent of -1 is returned. If -1 is a valid value for this field, it is important to check the |
| 2073 |
* GED_RETURN_VALUE result. |
| 2074 |
* |
| 2075 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 2076 |
*/ |
| 2077 |
extern uint32_t GED_CALLCONV GED_GetDescWidth(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 2078 |
|
| 2079 |
/*! |
| 2080 |
* Set the value of the DescWidth field in the given instruction. See @ref GED_INS_FIELD_DescWidth for the field's description. |
| 2081 |
* |
| 2082 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 2083 |
* @param[in] value The value to encode. |
| 2084 |
* |
| 2085 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 2086 |
*/ |
| 2087 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetDescWidth(ged_ins_t* ins, const uint32_t value); |
| 2088 |
|
| 2089 |
/*! |
| 2090 |
* Get the value of the DescVertStride field in the given instruction. See @ref GED_INS_FIELD_DescVertStride for the field's |
| 2091 |
* description. |
| 2092 |
* |
| 2093 |
* @param[in] ins Pointer to the decoded instruction object. |
| 2094 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 2095 |
* which caused the failure. |
| 2096 |
* |
| 2097 |
* @return The requested value upon success. If the encoded value is not valid, i.e. does not map to any valid enumerated value |
| 2098 |
* for this instruction, the (invalid) encoded value is returned. If the field is not valid for the instruction, the |
| 2099 |
* uint32_t equivalent of -1 is returned. If -1 is a valid value for this field, it is important to check the |
| 2100 |
* GED_RETURN_VALUE result. |
| 2101 |
* |
| 2102 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 2103 |
*/ |
| 2104 |
extern uint32_t GED_CALLCONV GED_GetDescVertStride(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 2105 |
|
| 2106 |
/*! |
| 2107 |
* Set the value of the DescVertStride field in the given instruction. See @ref GED_INS_FIELD_DescVertStride for the field's |
| 2108 |
* description. |
| 2109 |
* |
| 2110 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 2111 |
* @param[in] value The value to encode. |
| 2112 |
* |
| 2113 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 2114 |
*/ |
| 2115 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetDescVertStride(ged_ins_t* ins, const uint32_t value); |
| 2116 |
|
| 2117 |
/*! |
| 2118 |
* Get the value of the MsgDesc field in the given instruction. See @ref GED_INS_FIELD_MsgDesc for the field's description. |
| 2119 |
* |
| 2120 |
* @param[in] ins Pointer to the decoded instruction object. |
| 2121 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 2122 |
* which caused the failure. |
| 2123 |
* |
| 2124 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 2125 |
* it is important to check the GED_RETURN_VALUE result. |
| 2126 |
* |
| 2127 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 2128 |
*/ |
| 2129 |
extern uint32_t GED_CALLCONV GED_GetMsgDesc(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 2130 |
|
| 2131 |
/*! |
| 2132 |
* Set the value of the MsgDesc field in the given instruction. See @ref GED_INS_FIELD_MsgDesc for the field's description. |
| 2133 |
* |
| 2134 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 2135 |
* @param[in] value The value to encode. |
| 2136 |
* |
| 2137 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 2138 |
*/ |
| 2139 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetMsgDesc(ged_ins_t* ins, const uint32_t value); |
| 2140 |
|
| 2141 |
/*! |
| 2142 |
* Get the value of the ExMsgDescImm field in the given instruction. See @ref GED_INS_FIELD_ExMsgDescImm for the field's description. |
| 2143 |
* |
| 2144 |
* @param[in] ins Pointer to the decoded instruction object. |
| 2145 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 2146 |
* which caused the failure. |
| 2147 |
* |
| 2148 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 2149 |
* it is important to check the GED_RETURN_VALUE result. |
| 2150 |
* |
| 2151 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 2152 |
*/ |
| 2153 |
extern uint32_t GED_CALLCONV GED_GetExMsgDescImm(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 2154 |
|
| 2155 |
/*! |
| 2156 |
* Set the value of the ExMsgDescImm field in the given instruction. See @ref GED_INS_FIELD_ExMsgDescImm for the field's description. |
| 2157 |
* |
| 2158 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 2159 |
* @param[in] value The value to encode. |
| 2160 |
* |
| 2161 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 2162 |
*/ |
| 2163 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetExMsgDescImm(ged_ins_t* ins, const uint32_t value); |
| 2164 |
|
| 2165 |
/*! |
| 2166 |
* Get the value of the EOT field in the given instruction. The function returns an enumeration value. To obtain the enum entry's |
| 2167 |
* string representation, use @ref GED_GetEOTString. See @ref GED_INS_FIELD_EOT for the field's description. |
| 2168 |
* |
| 2169 |
* @param[in] ins Pointer to the decoded instruction object. |
| 2170 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 2171 |
* which caused the failure. |
| 2172 |
* |
| 2173 |
* @return EOT's enumeration if the field is valid, GED_EOT_INVALID otherwise. |
| 2174 |
* |
| 2175 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 2176 |
*/ |
| 2177 |
extern GED_EOT GED_CALLCONV GED_GetEOT(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 2178 |
|
| 2179 |
/*! |
| 2180 |
* Set the value of the EOT field in the given instruction. See @ref GED_INS_FIELD_EOT for the field's description. |
| 2181 |
* |
| 2182 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 2183 |
* @param[in] value The value to encode. |
| 2184 |
* |
| 2185 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 2186 |
*/ |
| 2187 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetEOT(ged_ins_t* ins, const GED_EOT value); |
| 2188 |
|
| 2189 |
/*! |
| 2190 |
* Get the value of the MathFC field in the given instruction. The function returns an enumeration value. To obtain the enum entry's |
| 2191 |
* string representation, use @ref GED_GetMathFCString. See @ref GED_INS_FIELD_MathFC for the field's description. |
| 2192 |
* |
| 2193 |
* @param[in] ins Pointer to the decoded instruction object. |
| 2194 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 2195 |
* which caused the failure. |
| 2196 |
* |
| 2197 |
* @return MathFC's enumeration if the field is valid, GED_MATH_FC_INVALID otherwise. |
| 2198 |
* |
| 2199 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 2200 |
*/ |
| 2201 |
extern GED_MATH_FC GED_CALLCONV GED_GetMathFC(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 2202 |
|
| 2203 |
/*! |
| 2204 |
* Set the value of the MathFC field in the given instruction. See @ref GED_INS_FIELD_MathFC for the field's description. |
| 2205 |
* |
| 2206 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 2207 |
* @param[in] value The value to encode. |
| 2208 |
* |
| 2209 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 2210 |
*/ |
| 2211 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetMathFC(ged_ins_t* ins, const GED_MATH_FC value); |
| 2212 |
|
| 2213 |
/*! |
| 2214 |
* Get the value of the JIP field in the given instruction. See @ref GED_INS_FIELD_JIP for the field's description. |
| 2215 |
* |
| 2216 |
* @param[in] ins Pointer to the decoded instruction object. |
| 2217 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 2218 |
* which caused the failure. |
| 2219 |
* |
| 2220 |
* @return The requested value if the field is valid, -1 otherwise. If -1 is a valid value for this field, it is important to |
| 2221 |
* check the GED_RETURN_VALUE result. |
| 2222 |
* |
| 2223 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 2224 |
*/ |
| 2225 |
extern int32_t GED_CALLCONV GED_GetJIP(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 2226 |
|
| 2227 |
/*! |
| 2228 |
* Set the value of the JIP field in the given instruction. See @ref GED_INS_FIELD_JIP for the field's description. |
| 2229 |
* |
| 2230 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 2231 |
* @param[in] value The value to encode. |
| 2232 |
* |
| 2233 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 2234 |
*/ |
| 2235 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetJIP(ged_ins_t* ins, const int32_t value); |
| 2236 |
|
| 2237 |
/*! |
| 2238 |
* Get the value of the UIP field in the given instruction. See @ref GED_INS_FIELD_UIP for the field's description. |
| 2239 |
* |
| 2240 |
* @param[in] ins Pointer to the decoded instruction object. |
| 2241 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 2242 |
* which caused the failure. |
| 2243 |
* |
| 2244 |
* @return The requested value if the field is valid, -1 otherwise. If -1 is a valid value for this field, it is important to |
| 2245 |
* check the GED_RETURN_VALUE result. |
| 2246 |
* |
| 2247 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 2248 |
*/ |
| 2249 |
extern int32_t GED_CALLCONV GED_GetUIP(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 2250 |
|
| 2251 |
/*! |
| 2252 |
* Set the value of the UIP field in the given instruction. See @ref GED_INS_FIELD_UIP for the field's description. |
| 2253 |
* |
| 2254 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 2255 |
* @param[in] value The value to encode. |
| 2256 |
* |
| 2257 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 2258 |
*/ |
| 2259 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetUIP(ged_ins_t* ins, const int32_t value); |
| 2260 |
|
| 2261 |
/*! |
| 2262 |
* Get the value of the ControlIndex field in the given instruction. See @ref GED_INS_FIELD_ControlIndex for the field's description. |
| 2263 |
* |
| 2264 |
* @param[in] ins Pointer to the decoded instruction object. |
| 2265 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 2266 |
* which caused the failure. |
| 2267 |
* |
| 2268 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 2269 |
* it is important to check the GED_RETURN_VALUE result. |
| 2270 |
* |
| 2271 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 2272 |
*/ |
| 2273 |
extern uint32_t GED_CALLCONV GED_GetControlIndex(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 2274 |
|
| 2275 |
/*! |
| 2276 |
* Set the value of the ControlIndex field in the given instruction. See @ref GED_INS_FIELD_ControlIndex for the field's description. |
| 2277 |
* |
| 2278 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 2279 |
* @param[in] value The value to encode. |
| 2280 |
* |
| 2281 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 2282 |
*/ |
| 2283 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetControlIndex(ged_ins_t* ins, const uint32_t value); |
| 2284 |
|
| 2285 |
/*! |
| 2286 |
* Get the value of the DataTypeIndex field in the given instruction. See @ref GED_INS_FIELD_DataTypeIndex for the field's |
| 2287 |
* description. |
| 2288 |
* |
| 2289 |
* @param[in] ins Pointer to the decoded instruction object. |
| 2290 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 2291 |
* which caused the failure. |
| 2292 |
* |
| 2293 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 2294 |
* it is important to check the GED_RETURN_VALUE result. |
| 2295 |
* |
| 2296 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 2297 |
*/ |
| 2298 |
extern uint32_t GED_CALLCONV GED_GetDataTypeIndex(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 2299 |
|
| 2300 |
/*! |
| 2301 |
* Set the value of the DataTypeIndex field in the given instruction. See @ref GED_INS_FIELD_DataTypeIndex for the field's |
| 2302 |
* description. |
| 2303 |
* |
| 2304 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 2305 |
* @param[in] value The value to encode. |
| 2306 |
* |
| 2307 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 2308 |
*/ |
| 2309 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetDataTypeIndex(ged_ins_t* ins, const uint32_t value); |
| 2310 |
|
| 2311 |
/*! |
| 2312 |
* Get the value of the SubRegIndex field in the given instruction. See @ref GED_INS_FIELD_SubRegIndex for the field's description. |
| 2313 |
* |
| 2314 |
* @param[in] ins Pointer to the decoded instruction object. |
| 2315 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 2316 |
* which caused the failure. |
| 2317 |
* |
| 2318 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 2319 |
* it is important to check the GED_RETURN_VALUE result. |
| 2320 |
* |
| 2321 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 2322 |
*/ |
| 2323 |
extern uint32_t GED_CALLCONV GED_GetSubRegIndex(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 2324 |
|
| 2325 |
/*! |
| 2326 |
* Set the value of the SubRegIndex field in the given instruction. See @ref GED_INS_FIELD_SubRegIndex for the field's description. |
| 2327 |
* |
| 2328 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 2329 |
* @param[in] value The value to encode. |
| 2330 |
* |
| 2331 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 2332 |
*/ |
| 2333 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSubRegIndex(ged_ins_t* ins, const uint32_t value); |
| 2334 |
|
| 2335 |
/*! |
| 2336 |
* Get the value of the Src0Index field in the given instruction. See @ref GED_INS_FIELD_Src0Index for the field's description. |
| 2337 |
* |
| 2338 |
* @param[in] ins Pointer to the decoded instruction object. |
| 2339 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 2340 |
* which caused the failure. |
| 2341 |
* |
| 2342 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 2343 |
* it is important to check the GED_RETURN_VALUE result. |
| 2344 |
* |
| 2345 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 2346 |
*/ |
| 2347 |
extern uint32_t GED_CALLCONV GED_GetSrc0Index(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 2348 |
|
| 2349 |
/*! |
| 2350 |
* Set the value of the Src0Index field in the given instruction. See @ref GED_INS_FIELD_Src0Index for the field's description. |
| 2351 |
* |
| 2352 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 2353 |
* @param[in] value The value to encode. |
| 2354 |
* |
| 2355 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 2356 |
*/ |
| 2357 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSrc0Index(ged_ins_t* ins, const uint32_t value); |
| 2358 |
|
| 2359 |
/*! |
| 2360 |
* Get the value of the Src1Index field in the given instruction. See @ref GED_INS_FIELD_Src1Index for the field's description. |
| 2361 |
* |
| 2362 |
* @param[in] ins Pointer to the decoded instruction object. |
| 2363 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 2364 |
* which caused the failure. |
| 2365 |
* |
| 2366 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 2367 |
* it is important to check the GED_RETURN_VALUE result. |
| 2368 |
* |
| 2369 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 2370 |
*/ |
| 2371 |
extern uint32_t GED_CALLCONV GED_GetSrc1Index(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 2372 |
|
| 2373 |
/*! |
| 2374 |
* Set the value of the Src1Index field in the given instruction. See @ref GED_INS_FIELD_Src1Index for the field's description. |
| 2375 |
* |
| 2376 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 2377 |
* @param[in] value The value to encode. |
| 2378 |
* |
| 2379 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 2380 |
*/ |
| 2381 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSrc1Index(ged_ins_t* ins, const uint32_t value); |
| 2382 |
|
| 2383 |
/*! |
| 2384 |
* Get the value of the DescIndex field in the given instruction. See @ref GED_INS_FIELD_DescIndex for the field's description. |
| 2385 |
* |
| 2386 |
* @param[in] ins Pointer to the decoded instruction object. |
| 2387 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 2388 |
* which caused the failure. |
| 2389 |
* |
| 2390 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 2391 |
* it is important to check the GED_RETURN_VALUE result. |
| 2392 |
* |
| 2393 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 2394 |
*/ |
| 2395 |
extern uint32_t GED_CALLCONV GED_GetDescIndex(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 2396 |
|
| 2397 |
/*! |
| 2398 |
* Set the value of the DescIndex field in the given instruction. See @ref GED_INS_FIELD_DescIndex for the field's description. |
| 2399 |
* |
| 2400 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 2401 |
* @param[in] value The value to encode. |
| 2402 |
* |
| 2403 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 2404 |
*/ |
| 2405 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetDescIndex(ged_ins_t* ins, const uint32_t value); |
| 2406 |
|
| 2407 |
/*! |
| 2408 |
* Get the value of the ExDescRegFile field in the given instruction. The function returns an enumeration value. To obtain the enum |
| 2409 |
* entry's string representation, use @ref GED_GetRegFileString. See @ref GED_INS_FIELD_ExDescRegFile for the field's description. |
| 2410 |
* |
| 2411 |
* @param[in] ins Pointer to the decoded instruction object. |
| 2412 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 2413 |
* which caused the failure. |
| 2414 |
* |
| 2415 |
* @return ExDescRegFile's enumeration if the field is valid, GED_REG_FILE_INVALID otherwise. |
| 2416 |
* |
| 2417 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 2418 |
*/ |
| 2419 |
extern GED_REG_FILE GED_CALLCONV GED_GetExDescRegFile(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 2420 |
|
| 2421 |
/*! |
| 2422 |
* Set the value of the ExDescRegFile field in the given instruction. See @ref GED_INS_FIELD_ExDescRegFile for the field's |
| 2423 |
* description. |
| 2424 |
* |
| 2425 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 2426 |
* @param[in] value The value to encode. |
| 2427 |
* |
| 2428 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 2429 |
*/ |
| 2430 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetExDescRegFile(ged_ins_t* ins, const GED_REG_FILE value); |
| 2431 |
|
| 2432 |
/*! |
| 2433 |
* Get the value of the DstMathMacroExt field in the given instruction. The function returns an enumeration value. To obtain the enum |
| 2434 |
* entry's string representation, use @ref GED_GetMathMacroExtString. See @ref GED_INS_FIELD_DstMathMacroExt for the field's |
| 2435 |
* description. |
| 2436 |
* |
| 2437 |
* @param[in] ins Pointer to the decoded instruction object. |
| 2438 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 2439 |
* which caused the failure. |
| 2440 |
* |
| 2441 |
* @return DstMathMacroExt's enumeration if the field is valid, GED_MATH_MACRO_EXT_INVALID otherwise. |
| 2442 |
* |
| 2443 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 2444 |
*/ |
| 2445 |
extern GED_MATH_MACRO_EXT GED_CALLCONV GED_GetDstMathMacroExt(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 2446 |
|
| 2447 |
/*! |
| 2448 |
* Set the value of the DstMathMacroExt field in the given instruction. See @ref GED_INS_FIELD_DstMathMacroExt for the field's |
| 2449 |
* description. |
| 2450 |
* |
| 2451 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 2452 |
* @param[in] value The value to encode. |
| 2453 |
* |
| 2454 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 2455 |
*/ |
| 2456 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetDstMathMacroExt(ged_ins_t* ins, const GED_MATH_MACRO_EXT value); |
| 2457 |
|
| 2458 |
/*! |
| 2459 |
* Get the value of the Src0MathMacroExt field in the given instruction. The function returns an enumeration value. To obtain the enum |
| 2460 |
* entry's string representation, use @ref GED_GetMathMacroExtString. See @ref GED_INS_FIELD_Src0MathMacroExt for the field's |
| 2461 |
* description. |
| 2462 |
* |
| 2463 |
* @param[in] ins Pointer to the decoded instruction object. |
| 2464 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 2465 |
* which caused the failure. |
| 2466 |
* |
| 2467 |
* @return Src0MathMacroExt's enumeration if the field is valid, GED_MATH_MACRO_EXT_INVALID otherwise. |
| 2468 |
* |
| 2469 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 2470 |
*/ |
| 2471 |
extern GED_MATH_MACRO_EXT GED_CALLCONV GED_GetSrc0MathMacroExt(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 2472 |
|
| 2473 |
/*! |
| 2474 |
* Set the value of the Src0MathMacroExt field in the given instruction. See @ref GED_INS_FIELD_Src0MathMacroExt for the field's |
| 2475 |
* description. |
| 2476 |
* |
| 2477 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 2478 |
* @param[in] value The value to encode. |
| 2479 |
* |
| 2480 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 2481 |
*/ |
| 2482 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSrc0MathMacroExt(ged_ins_t* ins, const GED_MATH_MACRO_EXT value); |
| 2483 |
|
| 2484 |
/*! |
| 2485 |
* Get the value of the Src1MathMacroExt field in the given instruction. The function returns an enumeration value. To obtain the enum |
| 2486 |
* entry's string representation, use @ref GED_GetMathMacroExtString. See @ref GED_INS_FIELD_Src1MathMacroExt for the field's |
| 2487 |
* description. |
| 2488 |
* |
| 2489 |
* @param[in] ins Pointer to the decoded instruction object. |
| 2490 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 2491 |
* which caused the failure. |
| 2492 |
* |
| 2493 |
* @return Src1MathMacroExt's enumeration if the field is valid, GED_MATH_MACRO_EXT_INVALID otherwise. |
| 2494 |
* |
| 2495 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 2496 |
*/ |
| 2497 |
extern GED_MATH_MACRO_EXT GED_CALLCONV GED_GetSrc1MathMacroExt(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 2498 |
|
| 2499 |
/*! |
| 2500 |
* Set the value of the Src1MathMacroExt field in the given instruction. See @ref GED_INS_FIELD_Src1MathMacroExt for the field's |
| 2501 |
* description. |
| 2502 |
* |
| 2503 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 2504 |
* @param[in] value The value to encode. |
| 2505 |
* |
| 2506 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 2507 |
*/ |
| 2508 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSrc1MathMacroExt(ged_ins_t* ins, const GED_MATH_MACRO_EXT value); |
| 2509 |
|
| 2510 |
/*! |
| 2511 |
* Get the value of the Src2MathMacroExt field in the given instruction. The function returns an enumeration value. To obtain the enum |
| 2512 |
* entry's string representation, use @ref GED_GetMathMacroExtString. See @ref GED_INS_FIELD_Src2MathMacroExt for the field's |
| 2513 |
* description. |
| 2514 |
* |
| 2515 |
* @param[in] ins Pointer to the decoded instruction object. |
| 2516 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 2517 |
* which caused the failure. |
| 2518 |
* |
| 2519 |
* @return Src2MathMacroExt's enumeration if the field is valid, GED_MATH_MACRO_EXT_INVALID otherwise. |
| 2520 |
* |
| 2521 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 2522 |
*/ |
| 2523 |
extern GED_MATH_MACRO_EXT GED_CALLCONV GED_GetSrc2MathMacroExt(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 2524 |
|
| 2525 |
/*! |
| 2526 |
* Set the value of the Src2MathMacroExt field in the given instruction. See @ref GED_INS_FIELD_Src2MathMacroExt for the field's |
| 2527 |
* description. |
| 2528 |
* |
| 2529 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 2530 |
* @param[in] value The value to encode. |
| 2531 |
* |
| 2532 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 2533 |
*/ |
| 2534 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSrc2MathMacroExt(ged_ins_t* ins, const GED_MATH_MACRO_EXT value); |
| 2535 |
|
| 2536 |
/*! |
| 2537 |
* Get the value of the BranchCtrl field in the given instruction. The function returns an enumeration value. To obtain the enum |
| 2538 |
* entry's string representation, use @ref GED_GetBranchCtrlString. See @ref GED_INS_FIELD_BranchCtrl for the field's description. |
| 2539 |
* |
| 2540 |
* @param[in] ins Pointer to the decoded instruction object. |
| 2541 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 2542 |
* which caused the failure. |
| 2543 |
* |
| 2544 |
* @return BranchCtrl's enumeration if the field is valid, GED_BRANCH_CTRL_INVALID otherwise. |
| 2545 |
* |
| 2546 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 2547 |
*/ |
| 2548 |
extern GED_BRANCH_CTRL GED_CALLCONV GED_GetBranchCtrl(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 2549 |
|
| 2550 |
/*! |
| 2551 |
* Set the value of the BranchCtrl field in the given instruction. See @ref GED_INS_FIELD_BranchCtrl for the field's description. |
| 2552 |
* |
| 2553 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 2554 |
* @param[in] value The value to encode. |
| 2555 |
* |
| 2556 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 2557 |
*/ |
| 2558 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetBranchCtrl(ged_ins_t* ins, const GED_BRANCH_CTRL value); |
| 2559 |
|
| 2560 |
/*! |
| 2561 |
* Get the value of the SourceIndex field in the given instruction. See @ref GED_INS_FIELD_SourceIndex for the field's description. |
| 2562 |
* |
| 2563 |
* @param[in] ins Pointer to the decoded instruction object. |
| 2564 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 2565 |
* which caused the failure. |
| 2566 |
* |
| 2567 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 2568 |
* it is important to check the GED_RETURN_VALUE result. |
| 2569 |
* |
| 2570 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 2571 |
*/ |
| 2572 |
extern uint32_t GED_CALLCONV GED_GetSourceIndex(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 2573 |
|
| 2574 |
/*! |
| 2575 |
* Set the value of the SourceIndex field in the given instruction. See @ref GED_INS_FIELD_SourceIndex for the field's description. |
| 2576 |
* |
| 2577 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 2578 |
* @param[in] value The value to encode. |
| 2579 |
* |
| 2580 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 2581 |
*/ |
| 2582 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSourceIndex(ged_ins_t* ins, const uint32_t value); |
| 2583 |
|
| 2584 |
/*! |
| 2585 |
* Get the value of the Src2DataType field in the given instruction. The function returns an enumeration value. To obtain the enum |
| 2586 |
* entry's string representation, use @ref GED_GetDataTypeString. See @ref GED_INS_FIELD_Src2DataType for the field's description. |
| 2587 |
* |
| 2588 |
* @param[in] ins Pointer to the decoded instruction object. |
| 2589 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 2590 |
* which caused the failure. |
| 2591 |
* |
| 2592 |
* @return Src2DataType's enumeration if the field is valid, GED_DATA_TYPE_INVALID otherwise. |
| 2593 |
* |
| 2594 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 2595 |
*/ |
| 2596 |
extern GED_DATA_TYPE GED_CALLCONV GED_GetSrc2DataType(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 2597 |
|
| 2598 |
/*! |
| 2599 |
* Set the value of the Src2DataType field in the given instruction. See @ref GED_INS_FIELD_Src2DataType for the field's description. |
| 2600 |
* |
| 2601 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 2602 |
* @param[in] value The value to encode. |
| 2603 |
* |
| 2604 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 2605 |
*/ |
| 2606 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSrc2DataType(ged_ins_t* ins, const GED_DATA_TYPE value); |
| 2607 |
|
| 2608 |
/*! |
| 2609 |
* Get the value of the NoSrcDepSet field in the given instruction. The function returns an enumeration value. To obtain the enum |
| 2610 |
* entry's string representation, use @ref GED_GetNoSrcDepSetString. See @ref GED_INS_FIELD_NoSrcDepSet for the field's description. |
| 2611 |
* |
| 2612 |
* @param[in] ins Pointer to the decoded instruction object. |
| 2613 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 2614 |
* which caused the failure. |
| 2615 |
* |
| 2616 |
* @return NoSrcDepSet's enumeration if the field is valid, GED_NO_SRC_DEP_SET_INVALID otherwise. |
| 2617 |
* |
| 2618 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 2619 |
*/ |
| 2620 |
extern GED_NO_SRC_DEP_SET GED_CALLCONV GED_GetNoSrcDepSet(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 2621 |
|
| 2622 |
/*! |
| 2623 |
* Set the value of the NoSrcDepSet field in the given instruction. See @ref GED_INS_FIELD_NoSrcDepSet for the field's description. |
| 2624 |
* |
| 2625 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 2626 |
* @param[in] value The value to encode. |
| 2627 |
* |
| 2628 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 2629 |
*/ |
| 2630 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetNoSrcDepSet(ged_ins_t* ins, const GED_NO_SRC_DEP_SET value); |
| 2631 |
|
| 2632 |
/*! |
| 2633 |
* Get the value of the ExFuncCtrl field in the given instruction. See @ref GED_INS_FIELD_ExFuncCtrl for the field's description. |
| 2634 |
* |
| 2635 |
* @param[in] ins Pointer to the decoded instruction object. |
| 2636 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 2637 |
* which caused the failure. |
| 2638 |
* |
| 2639 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 2640 |
* it is important to check the GED_RETURN_VALUE result. |
| 2641 |
* |
| 2642 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 2643 |
*/ |
| 2644 |
extern uint32_t GED_CALLCONV GED_GetExFuncCtrl(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 2645 |
|
| 2646 |
/*! |
| 2647 |
* Set the value of the ExFuncCtrl field in the given instruction. See @ref GED_INS_FIELD_ExFuncCtrl for the field's description. |
| 2648 |
* |
| 2649 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 2650 |
* @param[in] value The value to encode. |
| 2651 |
* |
| 2652 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 2653 |
*/ |
| 2654 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetExFuncCtrl(ged_ins_t* ins, const uint32_t value); |
| 2655 |
|
| 2656 |
/*! |
| 2657 |
* Get the value of the ExMsgLength field in the given instruction. See @ref GED_INS_FIELD_ExMsgLength for the field's description. |
| 2658 |
* |
| 2659 |
* @param[in] ins Pointer to the decoded instruction object. |
| 2660 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 2661 |
* which caused the failure. |
| 2662 |
* |
| 2663 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 2664 |
* it is important to check the GED_RETURN_VALUE result. |
| 2665 |
* |
| 2666 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 2667 |
*/ |
| 2668 |
extern uint32_t GED_CALLCONV GED_GetExMsgLength(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 2669 |
|
| 2670 |
/*! |
| 2671 |
* Set the value of the ExMsgLength field in the given instruction. See @ref GED_INS_FIELD_ExMsgLength for the field's description. |
| 2672 |
* |
| 2673 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 2674 |
* @param[in] value The value to encode. |
| 2675 |
* |
| 2676 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 2677 |
*/ |
| 2678 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetExMsgLength(ged_ins_t* ins, const uint32_t value); |
| 2679 |
|
| 2680 |
/*! |
| 2681 |
* Get the value of the ExDescAddrSubRegNum field in the given instruction. See @ref GED_INS_FIELD_ExDescAddrSubRegNum for the field's |
| 2682 |
* description. |
| 2683 |
* |
| 2684 |
* @param[in] ins Pointer to the decoded instruction object. |
| 2685 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 2686 |
* which caused the failure. |
| 2687 |
* |
| 2688 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 2689 |
* it is important to check the GED_RETURN_VALUE result. |
| 2690 |
* |
| 2691 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 2692 |
*/ |
| 2693 |
extern uint32_t GED_CALLCONV GED_GetExDescAddrSubRegNum(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 2694 |
|
| 2695 |
/*! |
| 2696 |
* Set the value of the ExDescAddrSubRegNum field in the given instruction. See @ref GED_INS_FIELD_ExDescAddrSubRegNum for the field's |
| 2697 |
* description. |
| 2698 |
* |
| 2699 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 2700 |
* @param[in] value The value to encode. |
| 2701 |
* |
| 2702 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 2703 |
*/ |
| 2704 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetExDescAddrSubRegNum(ged_ins_t* ins, const uint32_t value); |
| 2705 |
|
| 2706 |
/*! |
| 2707 |
* Get the value of the ExDescRegNum field in the given instruction. See @ref GED_INS_FIELD_ExDescRegNum for the field's description. |
| 2708 |
* |
| 2709 |
* @param[in] ins Pointer to the decoded instruction object. |
| 2710 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 2711 |
* which caused the failure. |
| 2712 |
* |
| 2713 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 2714 |
* it is important to check the GED_RETURN_VALUE result. |
| 2715 |
* |
| 2716 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 2717 |
*/ |
| 2718 |
extern uint32_t GED_CALLCONV GED_GetExDescRegNum(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 2719 |
|
| 2720 |
/*! |
| 2721 |
* Set the value of the ExDescRegNum field in the given instruction. See @ref GED_INS_FIELD_ExDescRegNum for the field's description. |
| 2722 |
* |
| 2723 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 2724 |
* @param[in] value The value to encode. |
| 2725 |
* |
| 2726 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 2727 |
*/ |
| 2728 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetExDescRegNum(ged_ins_t* ins, const uint32_t value); |
| 2729 |
|
| 2730 |
/*! |
| 2731 |
* Get the value of the MsgDescCategory field in the given instruction. See @ref GED_INS_FIELD_MsgDescCategory for the field's |
| 2732 |
* description. |
| 2733 |
* |
| 2734 |
* @param[in] ins Pointer to the decoded instruction object. |
| 2735 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 2736 |
* which caused the failure. |
| 2737 |
* |
| 2738 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 2739 |
* it is important to check the GED_RETURN_VALUE result. |
| 2740 |
* |
| 2741 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 2742 |
*/ |
| 2743 |
extern uint32_t GED_CALLCONV GED_GetMsgDescCategory(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 2744 |
|
| 2745 |
/*! |
| 2746 |
* Set the value of the MsgDescCategory field in the given instruction. See @ref GED_INS_FIELD_MsgDescCategory for the field's |
| 2747 |
* description. |
| 2748 |
* |
| 2749 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 2750 |
* @param[in] value The value to encode. |
| 2751 |
* |
| 2752 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 2753 |
*/ |
| 2754 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetMsgDescCategory(ged_ins_t* ins, const uint32_t value); |
| 2755 |
|
| 2756 |
/*! |
| 2757 |
* Get the value of the MsgDescScratchAddrOffset field in the given instruction. See @ref GED_INS_FIELD_MsgDescScratchAddrOffset for |
| 2758 |
* the field's description. |
| 2759 |
* |
| 2760 |
* @param[in] ins Pointer to the decoded instruction object. |
| 2761 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 2762 |
* which caused the failure. |
| 2763 |
* |
| 2764 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 2765 |
* it is important to check the GED_RETURN_VALUE result. |
| 2766 |
* |
| 2767 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 2768 |
*/ |
| 2769 |
extern uint32_t GED_CALLCONV GED_GetMsgDescScratchAddrOffset(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 2770 |
|
| 2771 |
/*! |
| 2772 |
* Set the value of the MsgDescScratchAddrOffset field in the given instruction. See @ref GED_INS_FIELD_MsgDescScratchAddrOffset for |
| 2773 |
* the field's description. |
| 2774 |
* |
| 2775 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 2776 |
* @param[in] value The value to encode. |
| 2777 |
* |
| 2778 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 2779 |
*/ |
| 2780 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetMsgDescScratchAddrOffset(ged_ins_t* ins, const uint32_t value); |
| 2781 |
|
| 2782 |
/*! |
| 2783 |
* Get the value of the MsgDescScratchBlockSize field in the given instruction. See @ref GED_INS_FIELD_MsgDescScratchBlockSize for the |
| 2784 |
* field's description. |
| 2785 |
* |
| 2786 |
* @param[in] ins Pointer to the decoded instruction object. |
| 2787 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 2788 |
* which caused the failure. |
| 2789 |
* |
| 2790 |
* @return The requested value upon success. If the encoded value is not valid, i.e. does not map to any valid enumerated value |
| 2791 |
* for this instruction, the (invalid) encoded value is returned. If the field is not valid for the instruction, the |
| 2792 |
* uint32_t equivalent of -1 is returned. If -1 is a valid value for this field, it is important to check the |
| 2793 |
* GED_RETURN_VALUE result. |
| 2794 |
* |
| 2795 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 2796 |
*/ |
| 2797 |
extern uint32_t GED_CALLCONV GED_GetMsgDescScratchBlockSize(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 2798 |
|
| 2799 |
/*! |
| 2800 |
* Set the value of the MsgDescScratchBlockSize field in the given instruction. See @ref GED_INS_FIELD_MsgDescScratchBlockSize for the |
| 2801 |
* field's description. |
| 2802 |
* |
| 2803 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 2804 |
* @param[in] value The value to encode. |
| 2805 |
* |
| 2806 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 2807 |
*/ |
| 2808 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetMsgDescScratchBlockSize(ged_ins_t* ins, const uint32_t value); |
| 2809 |
|
| 2810 |
/*! |
| 2811 |
* Get the value of the MsgDescScratchInvalidateAfterRead field in the given instruction. See @ref |
| 2812 |
* GED_INS_FIELD_MsgDescScratchInvalidateAfterRead for the field's description. |
| 2813 |
* |
| 2814 |
* @param[in] ins Pointer to the decoded instruction object. |
| 2815 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 2816 |
* which caused the failure. |
| 2817 |
* |
| 2818 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 2819 |
* it is important to check the GED_RETURN_VALUE result. |
| 2820 |
* |
| 2821 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 2822 |
*/ |
| 2823 |
extern uint32_t GED_CALLCONV GED_GetMsgDescScratchInvalidateAfterRead(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 2824 |
|
| 2825 |
/*! |
| 2826 |
* Set the value of the MsgDescScratchInvalidateAfterRead field in the given instruction. See @ref |
| 2827 |
* GED_INS_FIELD_MsgDescScratchInvalidateAfterRead for the field's description. |
| 2828 |
* |
| 2829 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 2830 |
* @param[in] value The value to encode. |
| 2831 |
* |
| 2832 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 2833 |
*/ |
| 2834 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetMsgDescScratchInvalidateAfterRead(ged_ins_t* ins, const uint32_t value); |
| 2835 |
|
| 2836 |
/*! |
| 2837 |
* Get the value of the MsgDescScratchChannelMode field in the given instruction. The function returns an enumeration value. To obtain |
| 2838 |
* the enum entry's string representation, use @ref GED_GetChannelModeString. See @ref GED_INS_FIELD_MsgDescScratchChannelMode for the |
| 2839 |
* field's description. |
| 2840 |
* |
| 2841 |
* @param[in] ins Pointer to the decoded instruction object. |
| 2842 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 2843 |
* which caused the failure. |
| 2844 |
* |
| 2845 |
* @return MsgDescScratchChannelMode's enumeration if the field is valid, GED_CHANNEL_MODE_INVALID otherwise. |
| 2846 |
* |
| 2847 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 2848 |
*/ |
| 2849 |
extern GED_CHANNEL_MODE GED_CALLCONV GED_GetMsgDescScratchChannelMode(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 2850 |
|
| 2851 |
/*! |
| 2852 |
* Set the value of the MsgDescScratchChannelMode field in the given instruction. See @ref GED_INS_FIELD_MsgDescScratchChannelMode for |
| 2853 |
* the field's description. |
| 2854 |
* |
| 2855 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 2856 |
* @param[in] value The value to encode. |
| 2857 |
* |
| 2858 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 2859 |
*/ |
| 2860 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetMsgDescScratchChannelMode(ged_ins_t* ins, const GED_CHANNEL_MODE value); |
| 2861 |
|
| 2862 |
/*! |
| 2863 |
* Get the value of the MsgDescScratchMessageType field in the given instruction. The function returns an enumeration value. To obtain |
| 2864 |
* the enum entry's string representation, use @ref GED_GetMessageTypeString. See @ref GED_INS_FIELD_MsgDescScratchMessageType for the |
| 2865 |
* field's description. |
| 2866 |
* |
| 2867 |
* @param[in] ins Pointer to the decoded instruction object. |
| 2868 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 2869 |
* which caused the failure. |
| 2870 |
* |
| 2871 |
* @return MsgDescScratchMessageType's enumeration if the field is valid, GED_MESSAGE_TYPE_INVALID otherwise. |
| 2872 |
* |
| 2873 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 2874 |
*/ |
| 2875 |
extern GED_MESSAGE_TYPE GED_CALLCONV GED_GetMsgDescScratchMessageType(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 2876 |
|
| 2877 |
/*! |
| 2878 |
* Set the value of the MsgDescScratchMessageType field in the given instruction. See @ref GED_INS_FIELD_MsgDescScratchMessageType for |
| 2879 |
* the field's description. |
| 2880 |
* |
| 2881 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 2882 |
* @param[in] value The value to encode. |
| 2883 |
* |
| 2884 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 2885 |
*/ |
| 2886 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetMsgDescScratchMessageType(ged_ins_t* ins, const GED_MESSAGE_TYPE value); |
| 2887 |
|
| 2888 |
/*! |
| 2889 |
* Get the value of the ExecutionDataType field in the given instruction. The function returns an enumeration value. To obtain the |
| 2890 |
* enum entry's string representation, use @ref GED_GetExecutionDataTypeString. See @ref GED_INS_FIELD_ExecutionDataType for the |
| 2891 |
* field's description. |
| 2892 |
* |
| 2893 |
* @param[in] ins Pointer to the decoded instruction object. |
| 2894 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 2895 |
* which caused the failure. |
| 2896 |
* |
| 2897 |
* @return ExecutionDataType's enumeration if the field is valid, GED_EXECUTION_DATA_TYPE_INVALID otherwise. |
| 2898 |
* |
| 2899 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 2900 |
*/ |
| 2901 |
extern GED_EXECUTION_DATA_TYPE GED_CALLCONV GED_GetExecutionDataType(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 2902 |
|
| 2903 |
/*! |
| 2904 |
* Set the value of the ExecutionDataType field in the given instruction. See @ref GED_INS_FIELD_ExecutionDataType for the field's |
| 2905 |
* description. |
| 2906 |
* |
| 2907 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 2908 |
* @param[in] value The value to encode. |
| 2909 |
* |
| 2910 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 2911 |
*/ |
| 2912 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetExecutionDataType(ged_ins_t* ins, const GED_EXECUTION_DATA_TYPE value); |
| 2913 |
|
| 2914 |
/*! |
| 2915 |
* Get the value of the Src0TernaryImm field in the given instruction. See @ref GED_INS_FIELD_Src0TernaryImm for the field's |
| 2916 |
* description. |
| 2917 |
* |
| 2918 |
* @param[in] ins Pointer to the decoded instruction object. |
| 2919 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 2920 |
* which caused the failure. |
| 2921 |
* |
| 2922 |
* @return The requested value if the field is valid, uint64_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 2923 |
* it is important to check the GED_RETURN_VALUE result. |
| 2924 |
* |
| 2925 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 2926 |
*/ |
| 2927 |
extern uint64_t GED_CALLCONV GED_GetSrc0TernaryImm(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 2928 |
|
| 2929 |
/*! |
| 2930 |
* Set the value of the Src0TernaryImm field in the given instruction. See @ref GED_INS_FIELD_Src0TernaryImm for the field's |
| 2931 |
* description. |
| 2932 |
* |
| 2933 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 2934 |
* @param[in] value The value to encode. |
| 2935 |
* |
| 2936 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 2937 |
*/ |
| 2938 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSrc0TernaryImm(ged_ins_t* ins, const uint64_t value); |
| 2939 |
|
| 2940 |
/*! |
| 2941 |
* Get the value of the Src2TernaryImm field in the given instruction. See @ref GED_INS_FIELD_Src2TernaryImm for the field's |
| 2942 |
* description. |
| 2943 |
* |
| 2944 |
* @param[in] ins Pointer to the decoded instruction object. |
| 2945 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 2946 |
* which caused the failure. |
| 2947 |
* |
| 2948 |
* @return The requested value if the field is valid, uint64_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 2949 |
* it is important to check the GED_RETURN_VALUE result. |
| 2950 |
* |
| 2951 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 2952 |
*/ |
| 2953 |
extern uint64_t GED_CALLCONV GED_GetSrc2TernaryImm(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 2954 |
|
| 2955 |
/*! |
| 2956 |
* Set the value of the Src2TernaryImm field in the given instruction. See @ref GED_INS_FIELD_Src2TernaryImm for the field's |
| 2957 |
* description. |
| 2958 |
* |
| 2959 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 2960 |
* @param[in] value The value to encode. |
| 2961 |
* |
| 2962 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 2963 |
*/ |
| 2964 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSrc2TernaryImm(ged_ins_t* ins, const uint64_t value); |
| 2965 |
|
| 2966 |
/*! |
| 2967 |
* Get the value of the Src2HorzStride field in the given instruction. See @ref GED_INS_FIELD_Src2HorzStride for the field's |
| 2968 |
* description. |
| 2969 |
* |
| 2970 |
* @param[in] ins Pointer to the decoded instruction object. |
| 2971 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 2972 |
* which caused the failure. |
| 2973 |
* |
| 2974 |
* @return The requested value upon success. If the encoded value is not valid, i.e. does not map to any valid enumerated value |
| 2975 |
* for this instruction, the (invalid) encoded value is returned. If the field is not valid for the instruction, the |
| 2976 |
* uint32_t equivalent of -1 is returned. If -1 is a valid value for this field, it is important to check the |
| 2977 |
* GED_RETURN_VALUE result. |
| 2978 |
* |
| 2979 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 2980 |
*/ |
| 2981 |
extern uint32_t GED_CALLCONV GED_GetSrc2HorzStride(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 2982 |
|
| 2983 |
/*! |
| 2984 |
* Set the value of the Src2HorzStride field in the given instruction. See @ref GED_INS_FIELD_Src2HorzStride for the field's |
| 2985 |
* description. |
| 2986 |
* |
| 2987 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 2988 |
* @param[in] value The value to encode. |
| 2989 |
* |
| 2990 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 2991 |
*/ |
| 2992 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSrc2HorzStride(ged_ins_t* ins, const uint32_t value); |
| 2993 |
|
| 2994 |
/*! |
| 2995 |
* Get the value of the SWSB field in the given instruction. See @ref GED_INS_FIELD_SWSB for the field's description. |
| 2996 |
* |
| 2997 |
* @param[in] ins Pointer to the decoded instruction object. |
| 2998 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 2999 |
* which caused the failure. |
| 3000 |
* |
| 3001 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 3002 |
* it is important to check the GED_RETURN_VALUE result. |
| 3003 |
* |
| 3004 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 3005 |
*/ |
| 3006 |
extern uint32_t GED_CALLCONV GED_GetSWSB(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 3007 |
|
| 3008 |
/*! |
| 3009 |
* Set the value of the SWSB field in the given instruction. See @ref GED_INS_FIELD_SWSB for the field's description. |
| 3010 |
* |
| 3011 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 3012 |
* @param[in] value The value to encode. |
| 3013 |
* |
| 3014 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 3015 |
*/ |
| 3016 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSWSB(ged_ins_t* ins, const uint32_t value); |
| 3017 |
|
| 3018 |
/*! |
| 3019 |
* Get the value of the Src1IsImm field in the given instruction. See @ref GED_INS_FIELD_Src1IsImm for the field's description. |
| 3020 |
* |
| 3021 |
* @param[in] ins Pointer to the decoded instruction object. |
| 3022 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 3023 |
* which caused the failure. |
| 3024 |
* |
| 3025 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 3026 |
* it is important to check the GED_RETURN_VALUE result. |
| 3027 |
* |
| 3028 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 3029 |
*/ |
| 3030 |
extern uint32_t GED_CALLCONV GED_GetSrc1IsImm(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 3031 |
|
| 3032 |
/*! |
| 3033 |
* Set the value of the Src1IsImm field in the given instruction. See @ref GED_INS_FIELD_Src1IsImm for the field's description. |
| 3034 |
* |
| 3035 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 3036 |
* @param[in] value The value to encode. |
| 3037 |
* |
| 3038 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 3039 |
*/ |
| 3040 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSrc1IsImm(ged_ins_t* ins, const uint32_t value); |
| 3041 |
|
| 3042 |
/*! |
| 3043 |
* Get the value of the Src0IsImm field in the given instruction. See @ref GED_INS_FIELD_Src0IsImm for the field's description. |
| 3044 |
* |
| 3045 |
* @param[in] ins Pointer to the decoded instruction object. |
| 3046 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 3047 |
* which caused the failure. |
| 3048 |
* |
| 3049 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 3050 |
* it is important to check the GED_RETURN_VALUE result. |
| 3051 |
* |
| 3052 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 3053 |
*/ |
| 3054 |
extern uint32_t GED_CALLCONV GED_GetSrc0IsImm(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 3055 |
|
| 3056 |
/*! |
| 3057 |
* Set the value of the Src0IsImm field in the given instruction. See @ref GED_INS_FIELD_Src0IsImm for the field's description. |
| 3058 |
* |
| 3059 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 3060 |
* @param[in] value The value to encode. |
| 3061 |
* |
| 3062 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 3063 |
*/ |
| 3064 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSrc0IsImm(ged_ins_t* ins, const uint32_t value); |
| 3065 |
|
| 3066 |
/*! |
| 3067 |
* Get the value of the Src0SubRegNumByte field in the given instruction. See @ref GED_INS_FIELD_Src0SubRegNumByte for the field's |
| 3068 |
* description. |
| 3069 |
* |
| 3070 |
* @param[in] ins Pointer to the decoded instruction object. |
| 3071 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 3072 |
* which caused the failure. |
| 3073 |
* |
| 3074 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 3075 |
* it is important to check the GED_RETURN_VALUE result. |
| 3076 |
* |
| 3077 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 3078 |
*/ |
| 3079 |
extern uint32_t GED_CALLCONV GED_GetSrc0SubRegNumByte(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 3080 |
|
| 3081 |
/*! |
| 3082 |
* Set the value of the Src0SubRegNumByte field in the given instruction. See @ref GED_INS_FIELD_Src0SubRegNumByte for the field's |
| 3083 |
* description. |
| 3084 |
* |
| 3085 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 3086 |
* @param[in] value The value to encode. |
| 3087 |
* |
| 3088 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 3089 |
*/ |
| 3090 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSrc0SubRegNumByte(ged_ins_t* ins, const uint32_t value); |
| 3091 |
|
| 3092 |
/*! |
| 3093 |
* Get the value of the SyncFC field in the given instruction. The function returns an enumeration value. To obtain the enum entry's |
| 3094 |
* string representation, use @ref GED_GetSyncFCString. See @ref GED_INS_FIELD_SyncFC for the field's description. |
| 3095 |
* |
| 3096 |
* @param[in] ins Pointer to the decoded instruction object. |
| 3097 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 3098 |
* which caused the failure. |
| 3099 |
* |
| 3100 |
* @return SyncFC's enumeration if the field is valid, GED_SYNC_FC_INVALID otherwise. |
| 3101 |
* |
| 3102 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 3103 |
*/ |
| 3104 |
extern GED_SYNC_FC GED_CALLCONV GED_GetSyncFC(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 3105 |
|
| 3106 |
/*! |
| 3107 |
* Set the value of the SyncFC field in the given instruction. See @ref GED_INS_FIELD_SyncFC for the field's description. |
| 3108 |
* |
| 3109 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 3110 |
* @param[in] value The value to encode. |
| 3111 |
* |
| 3112 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 3113 |
*/ |
| 3114 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSyncFC(ged_ins_t* ins, const GED_SYNC_FC value); |
| 3115 |
|
| 3116 |
/*! |
| 3117 |
* Get the value of the FusionCtrl field in the given instruction. The function returns an enumeration value. To obtain the enum |
| 3118 |
* entry's string representation, use @ref GED_GetFusionCtrlString. See @ref GED_INS_FIELD_FusionCtrl for the field's description. |
| 3119 |
* |
| 3120 |
* @param[in] ins Pointer to the decoded instruction object. |
| 3121 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 3122 |
* which caused the failure. |
| 3123 |
* |
| 3124 |
* @return FusionCtrl's enumeration if the field is valid, GED_FUSION_CTRL_INVALID otherwise. |
| 3125 |
* |
| 3126 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 3127 |
*/ |
| 3128 |
extern GED_FUSION_CTRL GED_CALLCONV GED_GetFusionCtrl(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 3129 |
|
| 3130 |
/*! |
| 3131 |
* Set the value of the FusionCtrl field in the given instruction. See @ref GED_INS_FIELD_FusionCtrl for the field's description. |
| 3132 |
* |
| 3133 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 3134 |
* @param[in] value The value to encode. |
| 3135 |
* |
| 3136 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 3137 |
*/ |
| 3138 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetFusionCtrl(ged_ins_t* ins, const GED_FUSION_CTRL value); |
| 3139 |
|
| 3140 |
/*! |
| 3141 |
* Get the value of the DataTypeIndexNoDep field in the given instruction. See @ref GED_INS_FIELD_DataTypeIndexNoDep for the field's |
| 3142 |
* description. |
| 3143 |
* |
| 3144 |
* @param[in] ins Pointer to the decoded instruction object. |
| 3145 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 3146 |
* which caused the failure. |
| 3147 |
* |
| 3148 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 3149 |
* it is important to check the GED_RETURN_VALUE result. |
| 3150 |
* |
| 3151 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 3152 |
*/ |
| 3153 |
extern uint32_t GED_CALLCONV GED_GetDataTypeIndexNoDep(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 3154 |
|
| 3155 |
/*! |
| 3156 |
* Set the value of the DataTypeIndexNoDep field in the given instruction. See @ref GED_INS_FIELD_DataTypeIndexNoDep for the field's |
| 3157 |
* description. |
| 3158 |
* |
| 3159 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 3160 |
* @param[in] value The value to encode. |
| 3161 |
* |
| 3162 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 3163 |
*/ |
| 3164 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetDataTypeIndexNoDep(ged_ins_t* ins, const uint32_t value); |
| 3165 |
|
| 3166 |
/*! |
| 3167 |
* Get the value of the CompactedImm field in the given instruction. See @ref GED_INS_FIELD_CompactedImm for the field's description. |
| 3168 |
* |
| 3169 |
* @param[in] ins Pointer to the decoded instruction object. |
| 3170 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 3171 |
* which caused the failure. |
| 3172 |
* |
| 3173 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 3174 |
* it is important to check the GED_RETURN_VALUE result. |
| 3175 |
* |
| 3176 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 3177 |
*/ |
| 3178 |
extern uint32_t GED_CALLCONV GED_GetCompactedImm(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 3179 |
|
| 3180 |
/*! |
| 3181 |
* Set the value of the CompactedImm field in the given instruction. See @ref GED_INS_FIELD_CompactedImm for the field's description. |
| 3182 |
* |
| 3183 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 3184 |
* @param[in] value The value to encode. |
| 3185 |
* |
| 3186 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 3187 |
*/ |
| 3188 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetCompactedImm(ged_ins_t* ins, const uint32_t value); |
| 3189 |
|
| 3190 |
/*! |
| 3191 |
* Get the value of the RepeatCount field in the given instruction. See @ref GED_INS_FIELD_RepeatCount for the field's description. |
| 3192 |
* |
| 3193 |
* @param[in] ins Pointer to the decoded instruction object. |
| 3194 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 3195 |
* which caused the failure. |
| 3196 |
* |
| 3197 |
* @return The requested value upon success. If the encoded value is not valid, i.e. does not map to any valid enumerated value |
| 3198 |
* for this instruction, the (invalid) encoded value is returned. If the field is not valid for the instruction, the |
| 3199 |
* uint32_t equivalent of -1 is returned. If -1 is a valid value for this field, it is important to check the |
| 3200 |
* GED_RETURN_VALUE result. |
| 3201 |
* |
| 3202 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 3203 |
*/ |
| 3204 |
extern uint32_t GED_CALLCONV GED_GetRepeatCount(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 3205 |
|
| 3206 |
/*! |
| 3207 |
* Set the value of the RepeatCount field in the given instruction. See @ref GED_INS_FIELD_RepeatCount for the field's description. |
| 3208 |
* |
| 3209 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 3210 |
* @param[in] value The value to encode. |
| 3211 |
* |
| 3212 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 3213 |
*/ |
| 3214 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetRepeatCount(ged_ins_t* ins, const uint32_t value); |
| 3215 |
|
| 3216 |
/*! |
| 3217 |
* Get the value of the SystolicDepth field in the given instruction. See @ref GED_INS_FIELD_SystolicDepth for the field's |
| 3218 |
* description. |
| 3219 |
* |
| 3220 |
* @param[in] ins Pointer to the decoded instruction object. |
| 3221 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 3222 |
* which caused the failure. |
| 3223 |
* |
| 3224 |
* @return The requested value upon success. If the encoded value is not valid, i.e. does not map to any valid enumerated value |
| 3225 |
* for this instruction, the (invalid) encoded value is returned. If the field is not valid for the instruction, the |
| 3226 |
* uint32_t equivalent of -1 is returned. If -1 is a valid value for this field, it is important to check the |
| 3227 |
* GED_RETURN_VALUE result. |
| 3228 |
* |
| 3229 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 3230 |
*/ |
| 3231 |
extern uint32_t GED_CALLCONV GED_GetSystolicDepth(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 3232 |
|
| 3233 |
/*! |
| 3234 |
* Set the value of the SystolicDepth field in the given instruction. See @ref GED_INS_FIELD_SystolicDepth for the field's |
| 3235 |
* description. |
| 3236 |
* |
| 3237 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 3238 |
* @param[in] value The value to encode. |
| 3239 |
* |
| 3240 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 3241 |
*/ |
| 3242 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSystolicDepth(ged_ins_t* ins, const uint32_t value); |
| 3243 |
|
| 3244 |
/*! |
| 3245 |
* Get the value of the Src2Precision field in the given instruction. The function returns an enumeration value. To obtain the enum |
| 3246 |
* entry's string representation, use @ref GED_GetPrecisionString. See @ref GED_INS_FIELD_Src2Precision for the field's description. |
| 3247 |
* |
| 3248 |
* @param[in] ins Pointer to the decoded instruction object. |
| 3249 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 3250 |
* which caused the failure. |
| 3251 |
* |
| 3252 |
* @return Src2Precision's enumeration if the field is valid, GED_PRECISION_INVALID otherwise. |
| 3253 |
* |
| 3254 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 3255 |
*/ |
| 3256 |
extern GED_PRECISION GED_CALLCONV GED_GetSrc2Precision(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 3257 |
|
| 3258 |
/*! |
| 3259 |
* Set the value of the Src2Precision field in the given instruction. See @ref GED_INS_FIELD_Src2Precision for the field's |
| 3260 |
* description. |
| 3261 |
* |
| 3262 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 3263 |
* @param[in] value The value to encode. |
| 3264 |
* |
| 3265 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 3266 |
*/ |
| 3267 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSrc2Precision(ged_ins_t* ins, const GED_PRECISION value); |
| 3268 |
|
| 3269 |
/*! |
| 3270 |
* Get the value of the Src2SubBytePrecision field in the given instruction. The function returns an enumeration value. To obtain the |
| 3271 |
* enum entry's string representation, use @ref GED_GetSubBytePrecisionString. See @ref GED_INS_FIELD_Src2SubBytePrecision for the |
| 3272 |
* field's description. |
| 3273 |
* |
| 3274 |
* @param[in] ins Pointer to the decoded instruction object. |
| 3275 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 3276 |
* which caused the failure. |
| 3277 |
* |
| 3278 |
* @return Src2SubBytePrecision's enumeration if the field is valid, GED_SUB_BYTE_PRECISION_INVALID otherwise. |
| 3279 |
* |
| 3280 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 3281 |
*/ |
| 3282 |
extern GED_SUB_BYTE_PRECISION GED_CALLCONV GED_GetSrc2SubBytePrecision(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 3283 |
|
| 3284 |
/*! |
| 3285 |
* Set the value of the Src2SubBytePrecision field in the given instruction. See @ref GED_INS_FIELD_Src2SubBytePrecision for the |
| 3286 |
* field's description. |
| 3287 |
* |
| 3288 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 3289 |
* @param[in] value The value to encode. |
| 3290 |
* |
| 3291 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 3292 |
*/ |
| 3293 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSrc2SubBytePrecision(ged_ins_t* ins, const GED_SUB_BYTE_PRECISION value); |
| 3294 |
|
| 3295 |
/*! |
| 3296 |
* Get the value of the Src1Precision field in the given instruction. The function returns an enumeration value. To obtain the enum |
| 3297 |
* entry's string representation, use @ref GED_GetPrecisionString. See @ref GED_INS_FIELD_Src1Precision for the field's description. |
| 3298 |
* |
| 3299 |
* @param[in] ins Pointer to the decoded instruction object. |
| 3300 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 3301 |
* which caused the failure. |
| 3302 |
* |
| 3303 |
* @return Src1Precision's enumeration if the field is valid, GED_PRECISION_INVALID otherwise. |
| 3304 |
* |
| 3305 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 3306 |
*/ |
| 3307 |
extern GED_PRECISION GED_CALLCONV GED_GetSrc1Precision(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 3308 |
|
| 3309 |
/*! |
| 3310 |
* Set the value of the Src1Precision field in the given instruction. See @ref GED_INS_FIELD_Src1Precision for the field's |
| 3311 |
* description. |
| 3312 |
* |
| 3313 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 3314 |
* @param[in] value The value to encode. |
| 3315 |
* |
| 3316 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 3317 |
*/ |
| 3318 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSrc1Precision(ged_ins_t* ins, const GED_PRECISION value); |
| 3319 |
|
| 3320 |
/*! |
| 3321 |
* Get the value of the Src1SubBytePrecision field in the given instruction. The function returns an enumeration value. To obtain the |
| 3322 |
* enum entry's string representation, use @ref GED_GetSubBytePrecisionString. See @ref GED_INS_FIELD_Src1SubBytePrecision for the |
| 3323 |
* field's description. |
| 3324 |
* |
| 3325 |
* @param[in] ins Pointer to the decoded instruction object. |
| 3326 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 3327 |
* which caused the failure. |
| 3328 |
* |
| 3329 |
* @return Src1SubBytePrecision's enumeration if the field is valid, GED_SUB_BYTE_PRECISION_INVALID otherwise. |
| 3330 |
* |
| 3331 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 3332 |
*/ |
| 3333 |
extern GED_SUB_BYTE_PRECISION GED_CALLCONV GED_GetSrc1SubBytePrecision(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 3334 |
|
| 3335 |
/*! |
| 3336 |
* Set the value of the Src1SubBytePrecision field in the given instruction. See @ref GED_INS_FIELD_Src1SubBytePrecision for the |
| 3337 |
* field's description. |
| 3338 |
* |
| 3339 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 3340 |
* @param[in] value The value to encode. |
| 3341 |
* |
| 3342 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 3343 |
*/ |
| 3344 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSrc1SubBytePrecision(ged_ins_t* ins, const GED_SUB_BYTE_PRECISION value); |
| 3345 |
|
| 3346 |
/*! |
| 3347 |
* Get the value of the BfnFC field in the given instruction. See @ref GED_INS_FIELD_BfnFC for the field's description. |
| 3348 |
* |
| 3349 |
* @param[in] ins Pointer to the decoded instruction object. |
| 3350 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 3351 |
* which caused the failure. |
| 3352 |
* |
| 3353 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 3354 |
* it is important to check the GED_RETURN_VALUE result. |
| 3355 |
* |
| 3356 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 3357 |
*/ |
| 3358 |
extern uint32_t GED_CALLCONV GED_GetBfnFC(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 3359 |
|
| 3360 |
/*! |
| 3361 |
* Set the value of the BfnFC field in the given instruction. See @ref GED_INS_FIELD_BfnFC for the field's description. |
| 3362 |
* |
| 3363 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 3364 |
* @param[in] value The value to encode. |
| 3365 |
* |
| 3366 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 3367 |
*/ |
| 3368 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetBfnFC(ged_ins_t* ins, const uint32_t value); |
| 3369 |
|
| 3370 |
/*! |
| 3371 |
* Get the value of the ExBSO field in the given instruction. See @ref GED_INS_FIELD_ExBSO for the field's description. |
| 3372 |
* |
| 3373 |
* @param[in] ins Pointer to the decoded instruction object. |
| 3374 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 3375 |
* which caused the failure. |
| 3376 |
* |
| 3377 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 3378 |
* it is important to check the GED_RETURN_VALUE result. |
| 3379 |
* |
| 3380 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 3381 |
*/ |
| 3382 |
extern uint32_t GED_CALLCONV GED_GetExBSO(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 3383 |
|
| 3384 |
/*! |
| 3385 |
* Set the value of the ExBSO field in the given instruction. See @ref GED_INS_FIELD_ExBSO for the field's description. |
| 3386 |
* |
| 3387 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 3388 |
* @param[in] value The value to encode. |
| 3389 |
* |
| 3390 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 3391 |
*/ |
| 3392 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetExBSO(ged_ins_t* ins, const uint32_t value); |
| 3393 |
|
| 3394 |
/*! |
| 3395 |
* Get the value of the CPS field in the given instruction. See @ref GED_INS_FIELD_CPS for the field's description. |
| 3396 |
* |
| 3397 |
* @param[in] ins Pointer to the decoded instruction object. |
| 3398 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 3399 |
* which caused the failure. |
| 3400 |
* |
| 3401 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 3402 |
* it is important to check the GED_RETURN_VALUE result. |
| 3403 |
* |
| 3404 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 3405 |
*/ |
| 3406 |
extern uint32_t GED_CALLCONV GED_GetCPS(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 3407 |
|
| 3408 |
/*! |
| 3409 |
* Set the value of the CPS field in the given instruction. See @ref GED_INS_FIELD_CPS for the field's description. |
| 3410 |
* |
| 3411 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 3412 |
* @param[in] value The value to encode. |
| 3413 |
* |
| 3414 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 3415 |
*/ |
| 3416 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetCPS(ged_ins_t* ins, const uint32_t value); |
| 3417 |
|
| 3418 |
/*! |
| 3419 |
* Get the value of the Src1Length field in the given instruction. See @ref GED_INS_FIELD_Src1Length for the field's description. |
| 3420 |
* |
| 3421 |
* @param[in] ins Pointer to the decoded instruction object. |
| 3422 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 3423 |
* which caused the failure. |
| 3424 |
* |
| 3425 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 3426 |
* it is important to check the GED_RETURN_VALUE result. |
| 3427 |
* |
| 3428 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 3429 |
*/ |
| 3430 |
extern uint32_t GED_CALLCONV GED_GetSrc1Length(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 3431 |
|
| 3432 |
/*! |
| 3433 |
* Set the value of the Src1Length field in the given instruction. See @ref GED_INS_FIELD_Src1Length for the field's description. |
| 3434 |
* |
| 3435 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 3436 |
* @param[in] value The value to encode. |
| 3437 |
* |
| 3438 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 3439 |
*/ |
| 3440 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSrc1Length(ged_ins_t* ins, const uint32_t value); |
| 3441 |
|
| 3442 |
/*! |
| 3443 |
* Get the value of the Src2IsImm field in the given instruction. See @ref GED_INS_FIELD_Src2IsImm for the field's description. |
| 3444 |
* |
| 3445 |
* @param[in] ins Pointer to the decoded instruction object. |
| 3446 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 3447 |
* which caused the failure. |
| 3448 |
* |
| 3449 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 3450 |
* it is important to check the GED_RETURN_VALUE result. |
| 3451 |
* |
| 3452 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 3453 |
*/ |
| 3454 |
extern uint32_t GED_CALLCONV GED_GetSrc2IsImm(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 3455 |
|
| 3456 |
/*! |
| 3457 |
* Set the value of the Src2IsImm field in the given instruction. See @ref GED_INS_FIELD_Src2IsImm for the field's description. |
| 3458 |
* |
| 3459 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 3460 |
* @param[in] value The value to encode. |
| 3461 |
* |
| 3462 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 3463 |
*/ |
| 3464 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSrc2IsImm(ged_ins_t* ins, const uint32_t value); |
| 3465 |
|
| 3466 |
/*! |
| 3467 |
* Get the value of the MetaRegFile field in the given instruction. The function returns an enumeration value. To obtain the enum |
| 3468 |
* entry's string representation, use @ref GED_GetRegFileString. See @ref GED_INS_FIELD_MetaRegFile for the field's description. |
| 3469 |
* |
| 3470 |
* @param[in] ins Pointer to the decoded instruction object. |
| 3471 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 3472 |
* which caused the failure. |
| 3473 |
* |
| 3474 |
* @return MetaRegFile's enumeration if the field is valid, GED_REG_FILE_INVALID otherwise. |
| 3475 |
* |
| 3476 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 3477 |
*/ |
| 3478 |
extern GED_REG_FILE GED_CALLCONV GED_GetMetaRegFile(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 3479 |
|
| 3480 |
/*! |
| 3481 |
* Set the value of the MetaRegFile field in the given instruction. See @ref GED_INS_FIELD_MetaRegFile for the field's description. |
| 3482 |
* |
| 3483 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 3484 |
* @param[in] value The value to encode. |
| 3485 |
* |
| 3486 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 3487 |
*/ |
| 3488 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetMetaRegFile(ged_ins_t* ins, const GED_REG_FILE value); |
| 3489 |
|
| 3490 |
/*! |
| 3491 |
* Get the value of the MetaSubRegNum field in the given instruction. See @ref GED_INS_FIELD_MetaSubRegNum for the field's |
| 3492 |
* description. |
| 3493 |
* |
| 3494 |
* @param[in] ins Pointer to the decoded instruction object. |
| 3495 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 3496 |
* which caused the failure. |
| 3497 |
* |
| 3498 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 3499 |
* it is important to check the GED_RETURN_VALUE result. |
| 3500 |
* |
| 3501 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 3502 |
*/ |
| 3503 |
extern uint32_t GED_CALLCONV GED_GetMetaSubRegNum(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 3504 |
|
| 3505 |
/*! |
| 3506 |
* Set the value of the MetaSubRegNum field in the given instruction. See @ref GED_INS_FIELD_MetaSubRegNum for the field's |
| 3507 |
* description. |
| 3508 |
* |
| 3509 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 3510 |
* @param[in] value The value to encode. |
| 3511 |
* |
| 3512 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 3513 |
*/ |
| 3514 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetMetaSubRegNum(ged_ins_t* ins, const uint32_t value); |
| 3515 |
|
| 3516 |
/*! |
| 3517 |
* Get the value of the MetaRegNum field in the given instruction. See @ref GED_INS_FIELD_MetaRegNum for the field's description. |
| 3518 |
* |
| 3519 |
* @param[in] ins Pointer to the decoded instruction object. |
| 3520 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 3521 |
* which caused the failure. |
| 3522 |
* |
| 3523 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 3524 |
* it is important to check the GED_RETURN_VALUE result. |
| 3525 |
* |
| 3526 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 3527 |
*/ |
| 3528 |
extern uint32_t GED_CALLCONV GED_GetMetaRegNum(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 3529 |
|
| 3530 |
/*! |
| 3531 |
* Set the value of the MetaRegNum field in the given instruction. See @ref GED_INS_FIELD_MetaRegNum for the field's description. |
| 3532 |
* |
| 3533 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 3534 |
* @param[in] value The value to encode. |
| 3535 |
* |
| 3536 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 3537 |
*/ |
| 3538 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetMetaRegNum(ged_ins_t* ins, const uint32_t value); |
| 3539 |
|
| 3540 |
/*! |
| 3541 |
* Get the value of the DstRegNum8 field in the given instruction. See @ref GED_INS_FIELD_DstRegNum8 for the field's description. |
| 3542 |
* |
| 3543 |
* @param[in] ins Pointer to the decoded instruction object. |
| 3544 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 3545 |
* which caused the failure. |
| 3546 |
* |
| 3547 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 3548 |
* it is important to check the GED_RETURN_VALUE result. |
| 3549 |
* |
| 3550 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 3551 |
*/ |
| 3552 |
extern uint32_t GED_CALLCONV GED_GetDstRegNum8(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 3553 |
|
| 3554 |
/*! |
| 3555 |
* Set the value of the DstRegNum8 field in the given instruction. See @ref GED_INS_FIELD_DstRegNum8 for the field's description. |
| 3556 |
* |
| 3557 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 3558 |
* @param[in] value The value to encode. |
| 3559 |
* |
| 3560 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 3561 |
*/ |
| 3562 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetDstRegNum8(ged_ins_t* ins, const uint32_t value); |
| 3563 |
|
| 3564 |
/*! |
| 3565 |
* Get the value of the Src0RegNum8 field in the given instruction. See @ref GED_INS_FIELD_Src0RegNum8 for the field's description. |
| 3566 |
* |
| 3567 |
* @param[in] ins Pointer to the decoded instruction object. |
| 3568 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 3569 |
* which caused the failure. |
| 3570 |
* |
| 3571 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 3572 |
* it is important to check the GED_RETURN_VALUE result. |
| 3573 |
* |
| 3574 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 3575 |
*/ |
| 3576 |
extern uint32_t GED_CALLCONV GED_GetSrc0RegNum8(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 3577 |
|
| 3578 |
/*! |
| 3579 |
* Set the value of the Src0RegNum8 field in the given instruction. See @ref GED_INS_FIELD_Src0RegNum8 for the field's description. |
| 3580 |
* |
| 3581 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 3582 |
* @param[in] value The value to encode. |
| 3583 |
* |
| 3584 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 3585 |
*/ |
| 3586 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSrc0RegNum8(ged_ins_t* ins, const uint32_t value); |
| 3587 |
|
| 3588 |
/*! |
| 3589 |
* Get the value of the LfsrFC field in the given instruction. The function returns an enumeration value. To obtain the enum entry's |
| 3590 |
* string representation, use @ref GED_GetLfsrFCString. See @ref GED_INS_FIELD_LfsrFC for the field's description. |
| 3591 |
* |
| 3592 |
* @param[in] ins Pointer to the decoded instruction object. |
| 3593 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 3594 |
* which caused the failure. |
| 3595 |
* |
| 3596 |
* @return LfsrFC's enumeration if the field is valid, GED_LFSR_FC_INVALID otherwise. |
| 3597 |
* |
| 3598 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 3599 |
*/ |
| 3600 |
extern GED_LFSR_FC GED_CALLCONV GED_GetLfsrFC(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 3601 |
|
| 3602 |
/*! |
| 3603 |
* Set the value of the LfsrFC field in the given instruction. See @ref GED_INS_FIELD_LfsrFC for the field's description. |
| 3604 |
* |
| 3605 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 3606 |
* @param[in] value The value to encode. |
| 3607 |
* |
| 3608 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 3609 |
*/ |
| 3610 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetLfsrFC(ged_ins_t* ins, const GED_LFSR_FC value); |
| 3611 |
|
| 3612 |
/*! |
| 3613 |
* Get the value of the ShuffleFC field in the given instruction. The function returns an enumeration value. To obtain the enum |
| 3614 |
* entry's string representation, use @ref GED_GetShuffleFCString. See @ref GED_INS_FIELD_ShuffleFC for the field's description. |
| 3615 |
* |
| 3616 |
* @param[in] ins Pointer to the decoded instruction object. |
| 3617 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 3618 |
* which caused the failure. |
| 3619 |
* |
| 3620 |
* @return ShuffleFC's enumeration if the field is valid, GED_SHUFFLE_FC_INVALID otherwise. |
| 3621 |
* |
| 3622 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 3623 |
*/ |
| 3624 |
extern GED_SHUFFLE_FC GED_CALLCONV GED_GetShuffleFC(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 3625 |
|
| 3626 |
/*! |
| 3627 |
* Set the value of the ShuffleFC field in the given instruction. See @ref GED_INS_FIELD_ShuffleFC for the field's description. |
| 3628 |
* |
| 3629 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 3630 |
* @param[in] value The value to encode. |
| 3631 |
* |
| 3632 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 3633 |
*/ |
| 3634 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetShuffleFC(ged_ins_t* ins, const GED_SHUFFLE_FC value); |
| 3635 |
|
| 3636 |
/*! |
| 3637 |
* Get the value of the Src1RegNum8 field in the given instruction. See @ref GED_INS_FIELD_Src1RegNum8 for the field's description. |
| 3638 |
* |
| 3639 |
* @param[in] ins Pointer to the decoded instruction object. |
| 3640 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 3641 |
* which caused the failure. |
| 3642 |
* |
| 3643 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 3644 |
* it is important to check the GED_RETURN_VALUE result. |
| 3645 |
* |
| 3646 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 3647 |
*/ |
| 3648 |
extern uint32_t GED_CALLCONV GED_GetSrc1RegNum8(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 3649 |
|
| 3650 |
/*! |
| 3651 |
* Set the value of the Src1RegNum8 field in the given instruction. See @ref GED_INS_FIELD_Src1RegNum8 for the field's description. |
| 3652 |
* |
| 3653 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 3654 |
* @param[in] value The value to encode. |
| 3655 |
* |
| 3656 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 3657 |
*/ |
| 3658 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSrc1RegNum8(ged_ins_t* ins, const uint32_t value); |
| 3659 |
|
| 3660 |
/*! |
| 3661 |
* Get the value of the Src1ScalarReg field in the given instruction. See @ref GED_INS_FIELD_Src1ScalarReg for the field's |
| 3662 |
* description. |
| 3663 |
* |
| 3664 |
* @param[in] ins Pointer to the decoded instruction object. |
| 3665 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 3666 |
* which caused the failure. |
| 3667 |
* |
| 3668 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 3669 |
* it is important to check the GED_RETURN_VALUE result. |
| 3670 |
* |
| 3671 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 3672 |
*/ |
| 3673 |
extern uint32_t GED_CALLCONV GED_GetSrc1ScalarReg(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 3674 |
|
| 3675 |
/*! |
| 3676 |
* Set the value of the Src1ScalarReg field in the given instruction. See @ref GED_INS_FIELD_Src1ScalarReg for the field's |
| 3677 |
* description. |
| 3678 |
* |
| 3679 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 3680 |
* @param[in] value The value to encode. |
| 3681 |
* |
| 3682 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 3683 |
*/ |
| 3684 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSrc1ScalarReg(ged_ins_t* ins, const uint32_t value); |
| 3685 |
|
| 3686 |
/*! |
| 3687 |
* Get the value of the Src2RegNum8 field in the given instruction. See @ref GED_INS_FIELD_Src2RegNum8 for the field's description. |
| 3688 |
* |
| 3689 |
* @param[in] ins Pointer to the decoded instruction object. |
| 3690 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 3691 |
* which caused the failure. |
| 3692 |
* |
| 3693 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 3694 |
* it is important to check the GED_RETURN_VALUE result. |
| 3695 |
* |
| 3696 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 3697 |
*/ |
| 3698 |
extern uint32_t GED_CALLCONV GED_GetSrc2RegNum8(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 3699 |
|
| 3700 |
/*! |
| 3701 |
* Set the value of the Src2RegNum8 field in the given instruction. See @ref GED_INS_FIELD_Src2RegNum8 for the field's description. |
| 3702 |
* |
| 3703 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 3704 |
* @param[in] value The value to encode. |
| 3705 |
* |
| 3706 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 3707 |
*/ |
| 3708 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSrc2RegNum8(ged_ins_t* ins, const uint32_t value); |
| 3709 |
|
| 3710 |
/*! |
| 3711 |
* Get the value of the FwdCtrl field in the given instruction. See @ref GED_INS_FIELD_FwdCtrl for the field's description. |
| 3712 |
* |
| 3713 |
* @param[in] ins Pointer to the decoded instruction object. |
| 3714 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 3715 |
* which caused the failure. |
| 3716 |
* |
| 3717 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 3718 |
* it is important to check the GED_RETURN_VALUE result. |
| 3719 |
* |
| 3720 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 3721 |
*/ |
| 3722 |
extern uint32_t GED_CALLCONV GED_GetFwdCtrl(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 3723 |
|
| 3724 |
/*! |
| 3725 |
* Set the value of the FwdCtrl field in the given instruction. See @ref GED_INS_FIELD_FwdCtrl for the field's description. |
| 3726 |
* |
| 3727 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 3728 |
* @param[in] value The value to encode. |
| 3729 |
* |
| 3730 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 3731 |
*/ |
| 3732 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetFwdCtrl(ged_ins_t* ins, const uint32_t value); |
| 3733 |
|
| 3734 |
/*! |
| 3735 |
* Get the value of the DnsclMode field in the given instruction. The function returns an enumeration value. To obtain the enum |
| 3736 |
* entry's string representation, use @ref GED_GetDnsclModeString. See @ref GED_INS_FIELD_DnsclMode for the field's description. |
| 3737 |
* |
| 3738 |
* @param[in] ins Pointer to the decoded instruction object. |
| 3739 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 3740 |
* which caused the failure. |
| 3741 |
* |
| 3742 |
* @return DnsclMode's enumeration if the field is valid, GED_DNSCL_MODE_INVALID otherwise. |
| 3743 |
* |
| 3744 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 3745 |
*/ |
| 3746 |
extern GED_DNSCL_MODE GED_CALLCONV GED_GetDnsclMode(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 3747 |
|
| 3748 |
/*! |
| 3749 |
* Set the value of the DnsclMode field in the given instruction. See @ref GED_INS_FIELD_DnsclMode for the field's description. |
| 3750 |
* |
| 3751 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 3752 |
* @param[in] value The value to encode. |
| 3753 |
* |
| 3754 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 3755 |
*/ |
| 3756 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetDnsclMode(ged_ins_t* ins, const GED_DNSCL_MODE value); |
| 3757 |
|
| 3758 |
/*! |
| 3759 |
* Get the value of the RoundingMode field in the given instruction. The function returns an enumeration value. To obtain the enum |
| 3760 |
* entry's string representation, use @ref GED_GetRoundingModeString. See @ref GED_INS_FIELD_RoundingMode for the field's description. |
| 3761 |
* |
| 3762 |
* @param[in] ins Pointer to the decoded instruction object. |
| 3763 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 3764 |
* which caused the failure. |
| 3765 |
* |
| 3766 |
* @return RoundingMode's enumeration if the field is valid, GED_ROUNDING_MODE_INVALID otherwise. |
| 3767 |
* |
| 3768 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 3769 |
*/ |
| 3770 |
extern GED_ROUNDING_MODE GED_CALLCONV GED_GetRoundingMode(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 3771 |
|
| 3772 |
/*! |
| 3773 |
* Set the value of the RoundingMode field in the given instruction. See @ref GED_INS_FIELD_RoundingMode for the field's description. |
| 3774 |
* |
| 3775 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 3776 |
* @param[in] value The value to encode. |
| 3777 |
* |
| 3778 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 3779 |
*/ |
| 3780 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetRoundingMode(ged_ins_t* ins, const GED_ROUNDING_MODE value); |
| 3781 |
|
| 3782 |
/*! |
| 3783 |
* Get the value of the ConvSrcDataType field in the given instruction. The function returns an enumeration value. To obtain the enum |
| 3784 |
* entry's string representation, use @ref GED_GetConvSrcDatatypeString. See @ref GED_INS_FIELD_ConvSrcDataType for the field's |
| 3785 |
* description. |
| 3786 |
* |
| 3787 |
* @param[in] ins Pointer to the decoded instruction object. |
| 3788 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 3789 |
* which caused the failure. |
| 3790 |
* |
| 3791 |
* @return ConvSrcDataType's enumeration if the field is valid, GED_CONV_SRC_DATATYPE_INVALID otherwise. |
| 3792 |
* |
| 3793 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 3794 |
*/ |
| 3795 |
extern GED_CONV_SRC_DATATYPE GED_CALLCONV GED_GetConvSrcDataType(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 3796 |
|
| 3797 |
/*! |
| 3798 |
* Set the value of the ConvSrcDataType field in the given instruction. See @ref GED_INS_FIELD_ConvSrcDataType for the field's |
| 3799 |
* description. |
| 3800 |
* |
| 3801 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 3802 |
* @param[in] value The value to encode. |
| 3803 |
* |
| 3804 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 3805 |
*/ |
| 3806 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetConvSrcDataType(ged_ins_t* ins, const GED_CONV_SRC_DATATYPE value); |
| 3807 |
|
| 3808 |
/*! |
| 3809 |
* Get the value of the ConvDstDataType field in the given instruction. The function returns an enumeration value. To obtain the enum |
| 3810 |
* entry's string representation, use @ref GED_GetConvDstDatatypeString. See @ref GED_INS_FIELD_ConvDstDataType for the field's |
| 3811 |
* description. |
| 3812 |
* |
| 3813 |
* @param[in] ins Pointer to the decoded instruction object. |
| 3814 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 3815 |
* which caused the failure. |
| 3816 |
* |
| 3817 |
* @return ConvDstDataType's enumeration if the field is valid, GED_CONV_DST_DATATYPE_INVALID otherwise. |
| 3818 |
* |
| 3819 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 3820 |
*/ |
| 3821 |
extern GED_CONV_DST_DATATYPE GED_CALLCONV GED_GetConvDstDataType(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 3822 |
|
| 3823 |
/*! |
| 3824 |
* Set the value of the ConvDstDataType field in the given instruction. See @ref GED_INS_FIELD_ConvDstDataType for the field's |
| 3825 |
* description. |
| 3826 |
* |
| 3827 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 3828 |
* @param[in] value The value to encode. |
| 3829 |
* |
| 3830 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 3831 |
*/ |
| 3832 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetConvDstDataType(ged_ins_t* ins, const GED_CONV_DST_DATATYPE value); |
| 3833 |
|
| 3834 |
/*! |
| 3835 |
* Get the value of the SendSwitchCtrl field in the given instruction. See @ref GED_INS_FIELD_SendSwitchCtrl for the field's |
| 3836 |
* description. |
| 3837 |
* |
| 3838 |
* @param[in] ins Pointer to the decoded instruction object. |
| 3839 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 3840 |
* which caused the failure. |
| 3841 |
* |
| 3842 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 3843 |
* it is important to check the GED_RETURN_VALUE result. |
| 3844 |
* |
| 3845 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 3846 |
*/ |
| 3847 |
extern uint32_t GED_CALLCONV GED_GetSendSwitchCtrl(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 3848 |
|
| 3849 |
/*! |
| 3850 |
* Set the value of the SendSwitchCtrl field in the given instruction. See @ref GED_INS_FIELD_SendSwitchCtrl for the field's |
| 3851 |
* description. |
| 3852 |
* |
| 3853 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 3854 |
* @param[in] value The value to encode. |
| 3855 |
* |
| 3856 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 3857 |
*/ |
| 3858 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSendSwitchCtrl(ged_ins_t* ins, const uint32_t value); |
| 3859 |
|
| 3860 |
/*! |
| 3861 |
* Get the value of the IndMsgDesc0IsPresent field in the given instruction. See @ref GED_INS_FIELD_IndMsgDesc0IsPresent for the |
| 3862 |
* field's description. |
| 3863 |
* |
| 3864 |
* @param[in] ins Pointer to the decoded instruction object. |
| 3865 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 3866 |
* which caused the failure. |
| 3867 |
* |
| 3868 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 3869 |
* it is important to check the GED_RETURN_VALUE result. |
| 3870 |
* |
| 3871 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 3872 |
*/ |
| 3873 |
extern uint32_t GED_CALLCONV GED_GetIndMsgDesc0IsPresent(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 3874 |
|
| 3875 |
/*! |
| 3876 |
* Set the value of the IndMsgDesc0IsPresent field in the given instruction. See @ref GED_INS_FIELD_IndMsgDesc0IsPresent for the |
| 3877 |
* field's description. |
| 3878 |
* |
| 3879 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 3880 |
* @param[in] value The value to encode. |
| 3881 |
* |
| 3882 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 3883 |
*/ |
| 3884 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetIndMsgDesc0IsPresent(ged_ins_t* ins, const uint32_t value); |
| 3885 |
|
| 3886 |
/*! |
| 3887 |
* Get the value of the IndMsgDesc1IsPresent field in the given instruction. See @ref GED_INS_FIELD_IndMsgDesc1IsPresent for the |
| 3888 |
* field's description. |
| 3889 |
* |
| 3890 |
* @param[in] ins Pointer to the decoded instruction object. |
| 3891 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 3892 |
* which caused the failure. |
| 3893 |
* |
| 3894 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 3895 |
* it is important to check the GED_RETURN_VALUE result. |
| 3896 |
* |
| 3897 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 3898 |
*/ |
| 3899 |
extern uint32_t GED_CALLCONV GED_GetIndMsgDesc1IsPresent(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 3900 |
|
| 3901 |
/*! |
| 3902 |
* Set the value of the IndMsgDesc1IsPresent field in the given instruction. See @ref GED_INS_FIELD_IndMsgDesc1IsPresent for the |
| 3903 |
* field's description. |
| 3904 |
* |
| 3905 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 3906 |
* @param[in] value The value to encode. |
| 3907 |
* |
| 3908 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 3909 |
*/ |
| 3910 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetIndMsgDesc1IsPresent(ged_ins_t* ins, const uint32_t value); |
| 3911 |
|
| 3912 |
/*! |
| 3913 |
* Get the value of the MsgDesc64 field in the given instruction. See @ref GED_INS_FIELD_MsgDesc64 for the field's description. |
| 3914 |
* |
| 3915 |
* @param[in] ins Pointer to the decoded instruction object. |
| 3916 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 3917 |
* which caused the failure. |
| 3918 |
* |
| 3919 |
* @return The requested value if the field is valid, uint64_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 3920 |
* it is important to check the GED_RETURN_VALUE result. |
| 3921 |
* |
| 3922 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 3923 |
*/ |
| 3924 |
extern uint64_t GED_CALLCONV GED_GetMsgDesc64(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 3925 |
|
| 3926 |
/*! |
| 3927 |
* Set the value of the MsgDesc64 field in the given instruction. See @ref GED_INS_FIELD_MsgDesc64 for the field's description. |
| 3928 |
* |
| 3929 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 3930 |
* @param[in] value The value to encode. |
| 3931 |
* |
| 3932 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 3933 |
*/ |
| 3934 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetMsgDesc64(ged_ins_t* ins, const uint64_t value); |
| 3935 |
|
| 3936 |
/*! |
| 3937 |
* Get the value of the IndMsgDesc1Addr field in the given instruction. See @ref GED_INS_FIELD_IndMsgDesc1Addr for the field's |
| 3938 |
* description. |
| 3939 |
* |
| 3940 |
* @param[in] ins Pointer to the decoded instruction object. |
| 3941 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 3942 |
* which caused the failure. |
| 3943 |
* |
| 3944 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 3945 |
* it is important to check the GED_RETURN_VALUE result. |
| 3946 |
* |
| 3947 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 3948 |
*/ |
| 3949 |
extern uint32_t GED_CALLCONV GED_GetIndMsgDesc1Addr(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 3950 |
|
| 3951 |
/*! |
| 3952 |
* Set the value of the IndMsgDesc1Addr field in the given instruction. See @ref GED_INS_FIELD_IndMsgDesc1Addr for the field's |
| 3953 |
* description. |
| 3954 |
* |
| 3955 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 3956 |
* @param[in] value The value to encode. |
| 3957 |
* |
| 3958 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 3959 |
*/ |
| 3960 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetIndMsgDesc1Addr(ged_ins_t* ins, const uint32_t value); |
| 3961 |
|
| 3962 |
/*! |
| 3963 |
* Get the value of the IndMsgDesc0Addr field in the given instruction. See @ref GED_INS_FIELD_IndMsgDesc0Addr for the field's |
| 3964 |
* description. |
| 3965 |
* |
| 3966 |
* @param[in] ins Pointer to the decoded instruction object. |
| 3967 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 3968 |
* which caused the failure. |
| 3969 |
* |
| 3970 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 3971 |
* it is important to check the GED_RETURN_VALUE result. |
| 3972 |
* |
| 3973 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 3974 |
*/ |
| 3975 |
extern uint32_t GED_CALLCONV GED_GetIndMsgDesc0Addr(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 3976 |
|
| 3977 |
/*! |
| 3978 |
* Set the value of the IndMsgDesc0Addr field in the given instruction. See @ref GED_INS_FIELD_IndMsgDesc0Addr for the field's |
| 3979 |
* description. |
| 3980 |
* |
| 3981 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 3982 |
* @param[in] value The value to encode. |
| 3983 |
* |
| 3984 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 3985 |
*/ |
| 3986 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetIndMsgDesc0Addr(ged_ins_t* ins, const uint32_t value); |
| 3987 |
|
| 3988 |
/*! |
| 3989 |
* Get the value of the Src0Length field in the given instruction. See @ref GED_INS_FIELD_Src0Length for the field's description. |
| 3990 |
* |
| 3991 |
* @param[in] ins Pointer to the decoded instruction object. |
| 3992 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 3993 |
* which caused the failure. |
| 3994 |
* |
| 3995 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 3996 |
* it is important to check the GED_RETURN_VALUE result. |
| 3997 |
* |
| 3998 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 3999 |
*/ |
| 4000 |
extern uint32_t GED_CALLCONV GED_GetSrc0Length(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 4001 |
|
| 4002 |
/*! |
| 4003 |
* Set the value of the Src0Length field in the given instruction. See @ref GED_INS_FIELD_Src0Length for the field's description. |
| 4004 |
* |
| 4005 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 4006 |
* @param[in] value The value to encode. |
| 4007 |
* |
| 4008 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 4009 |
*/ |
| 4010 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSrc0Length(ged_ins_t* ins, const uint32_t value); |
| 4011 |
|
| 4012 |
/*! |
| 4013 |
* Get the value of the Src4RegFile field in the given instruction. The function returns an enumeration value. To obtain the enum |
| 4014 |
* entry's string representation, use @ref GED_GetRegFileString. See @ref GED_INS_FIELD_Src4RegFile for the field's description. |
| 4015 |
* |
| 4016 |
* @param[in] ins Pointer to the decoded instruction object. |
| 4017 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 4018 |
* which caused the failure. |
| 4019 |
* |
| 4020 |
* @return Src4RegFile's enumeration if the field is valid, GED_REG_FILE_INVALID otherwise. |
| 4021 |
* |
| 4022 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 4023 |
*/ |
| 4024 |
extern GED_REG_FILE GED_CALLCONV GED_GetSrc4RegFile(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 4025 |
|
| 4026 |
/*! |
| 4027 |
* Set the value of the Src4RegFile field in the given instruction. See @ref GED_INS_FIELD_Src4RegFile for the field's description. |
| 4028 |
* |
| 4029 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 4030 |
* @param[in] value The value to encode. |
| 4031 |
* |
| 4032 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 4033 |
*/ |
| 4034 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSrc4RegFile(ged_ins_t* ins, const GED_REG_FILE value); |
| 4035 |
|
| 4036 |
/*! |
| 4037 |
* Get the value of the Src3RegFile field in the given instruction. The function returns an enumeration value. To obtain the enum |
| 4038 |
* entry's string representation, use @ref GED_GetRegFileString. See @ref GED_INS_FIELD_Src3RegFile for the field's description. |
| 4039 |
* |
| 4040 |
* @param[in] ins Pointer to the decoded instruction object. |
| 4041 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 4042 |
* which caused the failure. |
| 4043 |
* |
| 4044 |
* @return Src3RegFile's enumeration if the field is valid, GED_REG_FILE_INVALID otherwise. |
| 4045 |
* |
| 4046 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 4047 |
*/ |
| 4048 |
extern GED_REG_FILE GED_CALLCONV GED_GetSrc3RegFile(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 4049 |
|
| 4050 |
/*! |
| 4051 |
* Set the value of the Src3RegFile field in the given instruction. See @ref GED_INS_FIELD_Src3RegFile for the field's description. |
| 4052 |
* |
| 4053 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 4054 |
* @param[in] value The value to encode. |
| 4055 |
* |
| 4056 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 4057 |
*/ |
| 4058 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSrc3RegFile(ged_ins_t* ins, const GED_REG_FILE value); |
| 4059 |
|
| 4060 |
/*! |
| 4061 |
* Get the value of the Src4RegNum field in the given instruction. See @ref GED_INS_FIELD_Src4RegNum for the field's description. |
| 4062 |
* |
| 4063 |
* @param[in] ins Pointer to the decoded instruction object. |
| 4064 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 4065 |
* which caused the failure. |
| 4066 |
* |
| 4067 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 4068 |
* it is important to check the GED_RETURN_VALUE result. |
| 4069 |
* |
| 4070 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 4071 |
*/ |
| 4072 |
extern uint32_t GED_CALLCONV GED_GetSrc4RegNum(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 4073 |
|
| 4074 |
/*! |
| 4075 |
* Set the value of the Src4RegNum field in the given instruction. See @ref GED_INS_FIELD_Src4RegNum for the field's description. |
| 4076 |
* |
| 4077 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 4078 |
* @param[in] value The value to encode. |
| 4079 |
* |
| 4080 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 4081 |
*/ |
| 4082 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSrc4RegNum(ged_ins_t* ins, const uint32_t value); |
| 4083 |
|
| 4084 |
/*! |
| 4085 |
* Get the value of the Src3RegNum field in the given instruction. See @ref GED_INS_FIELD_Src3RegNum for the field's description. |
| 4086 |
* |
| 4087 |
* @param[in] ins Pointer to the decoded instruction object. |
| 4088 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 4089 |
* which caused the failure. |
| 4090 |
* |
| 4091 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 4092 |
* it is important to check the GED_RETURN_VALUE result. |
| 4093 |
* |
| 4094 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 4095 |
*/ |
| 4096 |
extern uint32_t GED_CALLCONV GED_GetSrc3RegNum(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 4097 |
|
| 4098 |
/*! |
| 4099 |
* Set the value of the Src3RegNum field in the given instruction. See @ref GED_INS_FIELD_Src3RegNum for the field's description. |
| 4100 |
* |
| 4101 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 4102 |
* @param[in] value The value to encode. |
| 4103 |
* |
| 4104 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 4105 |
*/ |
| 4106 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSrc3RegNum(ged_ins_t* ins, const uint32_t value); |
| 4107 |
|
| 4108 |
/*! |
| 4109 |
* Get the value of the SystolicDepthBlkScl field in the given instruction. See @ref GED_INS_FIELD_SystolicDepthBlkScl for the field's |
| 4110 |
* description. |
| 4111 |
* |
| 4112 |
* @param[in] ins Pointer to the decoded instruction object. |
| 4113 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 4114 |
* which caused the failure. |
| 4115 |
* |
| 4116 |
* @return The requested value upon success. If the encoded value is not valid, i.e. does not map to any valid enumerated value |
| 4117 |
* for this instruction, the (invalid) encoded value is returned. If the field is not valid for the instruction, the |
| 4118 |
* uint32_t equivalent of -1 is returned. If -1 is a valid value for this field, it is important to check the |
| 4119 |
* GED_RETURN_VALUE result. |
| 4120 |
* |
| 4121 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 4122 |
*/ |
| 4123 |
extern uint32_t GED_CALLCONV GED_GetSystolicDepthBlkScl(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 4124 |
|
| 4125 |
/*! |
| 4126 |
* Set the value of the SystolicDepthBlkScl field in the given instruction. See @ref GED_INS_FIELD_SystolicDepthBlkScl for the field's |
| 4127 |
* description. |
| 4128 |
* |
| 4129 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 4130 |
* @param[in] value The value to encode. |
| 4131 |
* |
| 4132 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 4133 |
*/ |
| 4134 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSystolicDepthBlkScl(ged_ins_t* ins, const uint32_t value); |
| 4135 |
|
| 4136 |
/*! |
| 4137 |
* Get the value of the Src4SubRegNum field in the given instruction. See @ref GED_INS_FIELD_Src4SubRegNum for the field's |
| 4138 |
* description. |
| 4139 |
* |
| 4140 |
* @param[in] ins Pointer to the decoded instruction object. |
| 4141 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 4142 |
* which caused the failure. |
| 4143 |
* |
| 4144 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 4145 |
* it is important to check the GED_RETURN_VALUE result. |
| 4146 |
* |
| 4147 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 4148 |
*/ |
| 4149 |
extern uint32_t GED_CALLCONV GED_GetSrc4SubRegNum(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 4150 |
|
| 4151 |
/*! |
| 4152 |
* Set the value of the Src4SubRegNum field in the given instruction. See @ref GED_INS_FIELD_Src4SubRegNum for the field's |
| 4153 |
* description. |
| 4154 |
* |
| 4155 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 4156 |
* @param[in] value The value to encode. |
| 4157 |
* |
| 4158 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 4159 |
*/ |
| 4160 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSrc4SubRegNum(ged_ins_t* ins, const uint32_t value); |
| 4161 |
|
| 4162 |
/*! |
| 4163 |
* Get the value of the Src3SubRegNum field in the given instruction. See @ref GED_INS_FIELD_Src3SubRegNum for the field's |
| 4164 |
* description. |
| 4165 |
* |
| 4166 |
* @param[in] ins Pointer to the decoded instruction object. |
| 4167 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 4168 |
* which caused the failure. |
| 4169 |
* |
| 4170 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 4171 |
* it is important to check the GED_RETURN_VALUE result. |
| 4172 |
* |
| 4173 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 4174 |
*/ |
| 4175 |
extern uint32_t GED_CALLCONV GED_GetSrc3SubRegNum(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 4176 |
|
| 4177 |
/*! |
| 4178 |
* Set the value of the Src3SubRegNum field in the given instruction. See @ref GED_INS_FIELD_Src3SubRegNum for the field's |
| 4179 |
* description. |
| 4180 |
* |
| 4181 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 4182 |
* @param[in] value The value to encode. |
| 4183 |
* |
| 4184 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 4185 |
*/ |
| 4186 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSrc3SubRegNum(ged_ins_t* ins, const uint32_t value); |
| 4187 |
|
| 4188 |
/*! |
| 4189 |
* Get the value of the Src3RegNum8 field in the given instruction. See @ref GED_INS_FIELD_Src3RegNum8 for the field's description. |
| 4190 |
* |
| 4191 |
* @param[in] ins Pointer to the decoded instruction object. |
| 4192 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 4193 |
* which caused the failure. |
| 4194 |
* |
| 4195 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 4196 |
* it is important to check the GED_RETURN_VALUE result. |
| 4197 |
* |
| 4198 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 4199 |
*/ |
| 4200 |
extern uint32_t GED_CALLCONV GED_GetSrc3RegNum8(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 4201 |
|
| 4202 |
/*! |
| 4203 |
* Set the value of the Src3RegNum8 field in the given instruction. See @ref GED_INS_FIELD_Src3RegNum8 for the field's description. |
| 4204 |
* |
| 4205 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 4206 |
* @param[in] value The value to encode. |
| 4207 |
* |
| 4208 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 4209 |
*/ |
| 4210 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSrc3RegNum8(ged_ins_t* ins, const uint32_t value); |
| 4211 |
|
| 4212 |
/*! |
| 4213 |
* Get the value of the Src4RegNum8 field in the given instruction. See @ref GED_INS_FIELD_Src4RegNum8 for the field's description. |
| 4214 |
* |
| 4215 |
* @param[in] ins Pointer to the decoded instruction object. |
| 4216 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 4217 |
* which caused the failure. |
| 4218 |
* |
| 4219 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 4220 |
* it is important to check the GED_RETURN_VALUE result. |
| 4221 |
* |
| 4222 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 4223 |
*/ |
| 4224 |
extern uint32_t GED_CALLCONV GED_GetSrc4RegNum8(ged_ins_t* ins, GED_RETURN_VALUE* result); |
| 4225 |
|
| 4226 |
/*! |
| 4227 |
* Set the value of the Src4RegNum8 field in the given instruction. See @ref GED_INS_FIELD_Src4RegNum8 for the field's description. |
| 4228 |
* |
| 4229 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 4230 |
* @param[in] value The value to encode. |
| 4231 |
* |
| 4232 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 4233 |
*/ |
| 4234 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSrc4RegNum8(ged_ins_t* ins, const uint32_t value); |
| 4235 |
|
| 4236 |
/*! |
| 4237 |
* Get the value of the Addr field which corresponds to an indexed IndMsgDesc operand in the given instruction. See @ref |
| 4238 |
* GED_INS_FIELD_IndMsgDesc0Addr, @ref GED_INS_FIELD_IndMsgDesc1Addr for the fields' description. |
| 4239 |
* |
| 4240 |
* @param[in] ins Pointer to the decoded instruction object. |
| 4241 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 4242 |
* which caused the failure. |
| 4243 |
* @param[in] index The index (number) of the source operand. |
| 4244 |
* |
| 4245 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 4246 |
* it is important to check the GED_RETURN_VALUE result. |
| 4247 |
* |
| 4248 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 4249 |
*/ |
| 4250 |
extern uint32_t GED_CALLCONV GED_GetIndexedIndMsgDescAddr(ged_ins_t* ins, GED_RETURN_VALUE* result, const uint8_t index); |
| 4251 |
|
| 4252 |
/*! |
| 4253 |
* Set the value of the Addr field which corresponds to an indexed IndMsgDesc operand in the given instruction. See @ref |
| 4254 |
* GED_INS_FIELD_IndMsgDesc0Addr, @ref GED_INS_FIELD_IndMsgDesc1Addr for the fields' description. |
| 4255 |
* |
| 4256 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 4257 |
* @param[in] value The value to encode. |
| 4258 |
* @param[in] index The index (number) of the source operand. |
| 4259 |
* |
| 4260 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 4261 |
*/ |
| 4262 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetIndexedIndMsgDescAddr(ged_ins_t* ins, const uint32_t value, const uint8_t index); |
| 4263 |
|
| 4264 |
/*! |
| 4265 |
* Get the value of the AddrImm field which corresponds to an indexed Src operand in the given instruction. See @ref |
| 4266 |
* GED_INS_FIELD_Src0AddrImm, @ref GED_INS_FIELD_Src1AddrImm for the fields' description. |
| 4267 |
* |
| 4268 |
* @param[in] ins Pointer to the decoded instruction object. |
| 4269 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 4270 |
* which caused the failure. |
| 4271 |
* @param[in] index The index (number) of the source operand. |
| 4272 |
* |
| 4273 |
* @return The requested value if the field is valid, -1 otherwise. If -1 is a valid value for this field, it is important to |
| 4274 |
* check the GED_RETURN_VALUE result. |
| 4275 |
* |
| 4276 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 4277 |
*/ |
| 4278 |
extern int32_t GED_CALLCONV GED_GetIndexedSrcAddrImm(ged_ins_t* ins, GED_RETURN_VALUE* result, const uint8_t index); |
| 4279 |
|
| 4280 |
/*! |
| 4281 |
* Set the value of the AddrImm field which corresponds to an indexed Src operand in the given instruction. See @ref |
| 4282 |
* GED_INS_FIELD_Src0AddrImm, @ref GED_INS_FIELD_Src1AddrImm for the fields' description. |
| 4283 |
* |
| 4284 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 4285 |
* @param[in] value The value to encode. |
| 4286 |
* @param[in] index The index (number) of the source operand. |
| 4287 |
* |
| 4288 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 4289 |
*/ |
| 4290 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetIndexedSrcAddrImm(ged_ins_t* ins, const int32_t value, const uint8_t index); |
| 4291 |
|
| 4292 |
/*! |
| 4293 |
* Get the value of the AddrMode field which corresponds to an indexed Src operand in the given instruction. See @ref |
| 4294 |
* GED_INS_FIELD_Src0AddrMode, @ref GED_INS_FIELD_Src1AddrMode, @ref GED_INS_FIELD_Src2AddrMode for the fields' description. |
| 4295 |
* |
| 4296 |
* @param[in] ins Pointer to the decoded instruction object. |
| 4297 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 4298 |
* which caused the failure. |
| 4299 |
* @param[in] index The index (number) of the source operand. |
| 4300 |
* |
| 4301 |
* @return Src3RegFile's enumeration if the field is valid, GED_REG_FILE_INVALID otherwise. |
| 4302 |
* |
| 4303 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 4304 |
*/ |
| 4305 |
extern GED_ADDR_MODE GED_CALLCONV GED_GetIndexedSrcAddrMode(ged_ins_t* ins, GED_RETURN_VALUE* result, const uint8_t index); |
| 4306 |
|
| 4307 |
/*! |
| 4308 |
* Set the value of the AddrMode field which corresponds to an indexed Src operand in the given instruction. See @ref |
| 4309 |
* GED_INS_FIELD_Src0AddrMode, @ref GED_INS_FIELD_Src1AddrMode, @ref GED_INS_FIELD_Src2AddrMode for the fields' description. |
| 4310 |
* |
| 4311 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 4312 |
* @param[in] value The value to encode. |
| 4313 |
* @param[in] index The index (number) of the source operand. |
| 4314 |
* |
| 4315 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 4316 |
*/ |
| 4317 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetIndexedSrcAddrMode(ged_ins_t* ins, const GED_ADDR_MODE value, const uint8_t index); |
| 4318 |
|
| 4319 |
/*! |
| 4320 |
* Get the value of the AddrSubRegNum field which corresponds to an indexed Src operand in the given instruction. See @ref |
| 4321 |
* GED_INS_FIELD_Src0AddrSubRegNum, @ref GED_INS_FIELD_Src1AddrSubRegNum for the fields' description. |
| 4322 |
* |
| 4323 |
* @param[in] ins Pointer to the decoded instruction object. |
| 4324 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 4325 |
* which caused the failure. |
| 4326 |
* @param[in] index The index (number) of the source operand. |
| 4327 |
* |
| 4328 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 4329 |
* it is important to check the GED_RETURN_VALUE result. |
| 4330 |
* |
| 4331 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 4332 |
*/ |
| 4333 |
extern uint32_t GED_CALLCONV GED_GetIndexedSrcAddrSubRegNum(ged_ins_t* ins, GED_RETURN_VALUE* result, const uint8_t index); |
| 4334 |
|
| 4335 |
/*! |
| 4336 |
* Set the value of the AddrSubRegNum field which corresponds to an indexed Src operand in the given instruction. See @ref |
| 4337 |
* GED_INS_FIELD_Src0AddrSubRegNum, @ref GED_INS_FIELD_Src1AddrSubRegNum for the fields' description. |
| 4338 |
* |
| 4339 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 4340 |
* @param[in] value The value to encode. |
| 4341 |
* @param[in] index The index (number) of the source operand. |
| 4342 |
* |
| 4343 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 4344 |
*/ |
| 4345 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetIndexedSrcAddrSubRegNum(ged_ins_t* ins, const uint32_t value, const uint8_t index); |
| 4346 |
|
| 4347 |
/*! |
| 4348 |
* Get the value of the ChanSel field which corresponds to an indexed Src operand in the given instruction. See @ref |
| 4349 |
* GED_INS_FIELD_Src0ChanSel, @ref GED_INS_FIELD_Src1ChanSel, @ref GED_INS_FIELD_Src2ChanSel for the fields' description. |
| 4350 |
* |
| 4351 |
* @param[in] ins Pointer to the decoded instruction object. |
| 4352 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 4353 |
* which caused the failure. |
| 4354 |
* @param[in] index The index (number) of the source operand. |
| 4355 |
* |
| 4356 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 4357 |
* it is important to check the GED_RETURN_VALUE result. |
| 4358 |
* |
| 4359 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 4360 |
*/ |
| 4361 |
extern uint32_t GED_CALLCONV GED_GetIndexedSrcChanSel(ged_ins_t* ins, GED_RETURN_VALUE* result, const uint8_t index); |
| 4362 |
|
| 4363 |
/*! |
| 4364 |
* Set the value of the ChanSel field which corresponds to an indexed Src operand in the given instruction. See @ref |
| 4365 |
* GED_INS_FIELD_Src0ChanSel, @ref GED_INS_FIELD_Src1ChanSel, @ref GED_INS_FIELD_Src2ChanSel for the fields' description. |
| 4366 |
* |
| 4367 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 4368 |
* @param[in] value The value to encode. |
| 4369 |
* @param[in] index The index (number) of the source operand. |
| 4370 |
* |
| 4371 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 4372 |
*/ |
| 4373 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetIndexedSrcChanSel(ged_ins_t* ins, const uint32_t value, const uint8_t index); |
| 4374 |
|
| 4375 |
/*! |
| 4376 |
* Get the value of the DataType field which corresponds to an indexed Src operand in the given instruction. See @ref |
| 4377 |
* GED_INS_FIELD_Src0DataType, @ref GED_INS_FIELD_Src1DataType, @ref GED_INS_FIELD_Src2DataType for the fields' description. |
| 4378 |
* |
| 4379 |
* @param[in] ins Pointer to the decoded instruction object. |
| 4380 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 4381 |
* which caused the failure. |
| 4382 |
* @param[in] index The index (number) of the source operand. |
| 4383 |
* |
| 4384 |
* @return Src3RegFile's enumeration if the field is valid, GED_REG_FILE_INVALID otherwise. |
| 4385 |
* |
| 4386 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 4387 |
*/ |
| 4388 |
extern GED_DATA_TYPE GED_CALLCONV GED_GetIndexedSrcDataType(ged_ins_t* ins, GED_RETURN_VALUE* result, const uint8_t index); |
| 4389 |
|
| 4390 |
/*! |
| 4391 |
* Set the value of the DataType field which corresponds to an indexed Src operand in the given instruction. See @ref |
| 4392 |
* GED_INS_FIELD_Src0DataType, @ref GED_INS_FIELD_Src1DataType, @ref GED_INS_FIELD_Src2DataType for the fields' description. |
| 4393 |
* |
| 4394 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 4395 |
* @param[in] value The value to encode. |
| 4396 |
* @param[in] index The index (number) of the source operand. |
| 4397 |
* |
| 4398 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 4399 |
*/ |
| 4400 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetIndexedSrcDataType(ged_ins_t* ins, const GED_DATA_TYPE value, const uint8_t index); |
| 4401 |
|
| 4402 |
/*! |
| 4403 |
* Get the value of the HorzStride field which corresponds to an indexed Src operand in the given instruction. See @ref |
| 4404 |
* GED_INS_FIELD_Src0HorzStride, @ref GED_INS_FIELD_Src1HorzStride, @ref GED_INS_FIELD_Src2HorzStride for the fields' description. |
| 4405 |
* |
| 4406 |
* @param[in] ins Pointer to the decoded instruction object. |
| 4407 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 4408 |
* which caused the failure. |
| 4409 |
* @param[in] index The index (number) of the source operand. |
| 4410 |
* |
| 4411 |
* @return The requested value upon success. If the encoded value is not valid, i.e. does not map to any valid enumerated value |
| 4412 |
* for this instruction, the (invalid) encoded value is returned. If the field is not valid for the instruction, the |
| 4413 |
* uint32_t equivalent of -1 is returned. If -1 is a valid value for this field, it is important to check the |
| 4414 |
* GED_RETURN_VALUE result. |
| 4415 |
* |
| 4416 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 4417 |
*/ |
| 4418 |
extern uint32_t GED_CALLCONV GED_GetIndexedSrcHorzStride(ged_ins_t* ins, GED_RETURN_VALUE* result, const uint8_t index); |
| 4419 |
|
| 4420 |
/*! |
| 4421 |
* Set the value of the HorzStride field which corresponds to an indexed Src operand in the given instruction. See @ref |
| 4422 |
* GED_INS_FIELD_Src0HorzStride, @ref GED_INS_FIELD_Src1HorzStride, @ref GED_INS_FIELD_Src2HorzStride for the fields' description. |
| 4423 |
* |
| 4424 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 4425 |
* @param[in] value The value to encode. |
| 4426 |
* @param[in] index The index (number) of the source operand. |
| 4427 |
* |
| 4428 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 4429 |
*/ |
| 4430 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetIndexedSrcHorzStride(ged_ins_t* ins, const uint32_t value, const uint8_t index); |
| 4431 |
|
| 4432 |
/*! |
| 4433 |
* Get the value of the Index field which corresponds to an indexed Src operand in the given instruction. See @ref |
| 4434 |
* GED_INS_FIELD_Src0Index, @ref GED_INS_FIELD_Src1Index for the fields' description. |
| 4435 |
* |
| 4436 |
* @param[in] ins Pointer to the decoded instruction object. |
| 4437 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 4438 |
* which caused the failure. |
| 4439 |
* @param[in] index The index (number) of the source operand. |
| 4440 |
* |
| 4441 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 4442 |
* it is important to check the GED_RETURN_VALUE result. |
| 4443 |
* |
| 4444 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 4445 |
*/ |
| 4446 |
extern uint32_t GED_CALLCONV GED_GetIndexedSrcIndex(ged_ins_t* ins, GED_RETURN_VALUE* result, const uint8_t index); |
| 4447 |
|
| 4448 |
/*! |
| 4449 |
* Set the value of the Index field which corresponds to an indexed Src operand in the given instruction. See @ref |
| 4450 |
* GED_INS_FIELD_Src0Index, @ref GED_INS_FIELD_Src1Index for the fields' description. |
| 4451 |
* |
| 4452 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 4453 |
* @param[in] value The value to encode. |
| 4454 |
* @param[in] index The index (number) of the source operand. |
| 4455 |
* |
| 4456 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 4457 |
*/ |
| 4458 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetIndexedSrcIndex(ged_ins_t* ins, const uint32_t value, const uint8_t index); |
| 4459 |
|
| 4460 |
/*! |
| 4461 |
* Get the value of the IsImm field which corresponds to an indexed Src operand in the given instruction. See @ref |
| 4462 |
* GED_INS_FIELD_Src0IsImm, @ref GED_INS_FIELD_Src1IsImm, @ref GED_INS_FIELD_Src2IsImm for the fields' description. |
| 4463 |
* |
| 4464 |
* @param[in] ins Pointer to the decoded instruction object. |
| 4465 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 4466 |
* which caused the failure. |
| 4467 |
* @param[in] index The index (number) of the source operand. |
| 4468 |
* |
| 4469 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 4470 |
* it is important to check the GED_RETURN_VALUE result. |
| 4471 |
* |
| 4472 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 4473 |
*/ |
| 4474 |
extern uint32_t GED_CALLCONV GED_GetIndexedSrcIsImm(ged_ins_t* ins, GED_RETURN_VALUE* result, const uint8_t index); |
| 4475 |
|
| 4476 |
/*! |
| 4477 |
* Set the value of the IsImm field which corresponds to an indexed Src operand in the given instruction. See @ref |
| 4478 |
* GED_INS_FIELD_Src0IsImm, @ref GED_INS_FIELD_Src1IsImm, @ref GED_INS_FIELD_Src2IsImm for the fields' description. |
| 4479 |
* |
| 4480 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 4481 |
* @param[in] value The value to encode. |
| 4482 |
* @param[in] index The index (number) of the source operand. |
| 4483 |
* |
| 4484 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 4485 |
*/ |
| 4486 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetIndexedSrcIsImm(ged_ins_t* ins, const uint32_t value, const uint8_t index); |
| 4487 |
|
| 4488 |
/*! |
| 4489 |
* Get the value of the IsPresent field which corresponds to an indexed IndMsgDesc operand in the given instruction. See @ref |
| 4490 |
* GED_INS_FIELD_IndMsgDesc0IsPresent, @ref GED_INS_FIELD_IndMsgDesc1IsPresent for the fields' description. |
| 4491 |
* |
| 4492 |
* @param[in] ins Pointer to the decoded instruction object. |
| 4493 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 4494 |
* which caused the failure. |
| 4495 |
* @param[in] index The index (number) of the source operand. |
| 4496 |
* |
| 4497 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 4498 |
* it is important to check the GED_RETURN_VALUE result. |
| 4499 |
* |
| 4500 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 4501 |
*/ |
| 4502 |
extern uint32_t GED_CALLCONV GED_GetIndexedIndMsgDescIsPresent(ged_ins_t* ins, GED_RETURN_VALUE* result, const uint8_t index); |
| 4503 |
|
| 4504 |
/*! |
| 4505 |
* Set the value of the IsPresent field which corresponds to an indexed IndMsgDesc operand in the given instruction. See @ref |
| 4506 |
* GED_INS_FIELD_IndMsgDesc0IsPresent, @ref GED_INS_FIELD_IndMsgDesc1IsPresent for the fields' description. |
| 4507 |
* |
| 4508 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 4509 |
* @param[in] value The value to encode. |
| 4510 |
* @param[in] index The index (number) of the source operand. |
| 4511 |
* |
| 4512 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 4513 |
*/ |
| 4514 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetIndexedIndMsgDescIsPresent(ged_ins_t* ins, const uint32_t value, const uint8_t index); |
| 4515 |
|
| 4516 |
/*! |
| 4517 |
* Get the value of the MathMacroExt field which corresponds to an indexed Src operand in the given instruction. See @ref |
| 4518 |
* GED_INS_FIELD_Src0MathMacroExt, @ref GED_INS_FIELD_Src1MathMacroExt, @ref GED_INS_FIELD_Src2MathMacroExt for the fields' |
| 4519 |
* description. |
| 4520 |
* |
| 4521 |
* @param[in] ins Pointer to the decoded instruction object. |
| 4522 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 4523 |
* which caused the failure. |
| 4524 |
* @param[in] index The index (number) of the source operand. |
| 4525 |
* |
| 4526 |
* @return Src3RegFile's enumeration if the field is valid, GED_REG_FILE_INVALID otherwise. |
| 4527 |
* |
| 4528 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 4529 |
*/ |
| 4530 |
extern GED_MATH_MACRO_EXT GED_CALLCONV GED_GetIndexedSrcMathMacroExt(ged_ins_t* ins, GED_RETURN_VALUE* result, const uint8_t index); |
| 4531 |
|
| 4532 |
/*! |
| 4533 |
* Set the value of the MathMacroExt field which corresponds to an indexed Src operand in the given instruction. See @ref |
| 4534 |
* GED_INS_FIELD_Src0MathMacroExt, @ref GED_INS_FIELD_Src1MathMacroExt, @ref GED_INS_FIELD_Src2MathMacroExt for the fields' |
| 4535 |
* description. |
| 4536 |
* |
| 4537 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 4538 |
* @param[in] value The value to encode. |
| 4539 |
* @param[in] index The index (number) of the source operand. |
| 4540 |
* |
| 4541 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 4542 |
*/ |
| 4543 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetIndexedSrcMathMacroExt(ged_ins_t* ins, const GED_MATH_MACRO_EXT value, const uint8_t |
| 4544 |
index); |
| 4545 |
|
| 4546 |
/*! |
| 4547 |
* Get the value of the RegFile field which corresponds to an indexed Src operand in the given instruction. See @ref |
| 4548 |
* GED_INS_FIELD_Src0RegFile, @ref GED_INS_FIELD_Src1RegFile, @ref GED_INS_FIELD_Src2RegFile, @ref GED_INS_FIELD_Src3RegFile, @ref |
| 4549 |
* GED_INS_FIELD_Src4RegFile for the fields' description. |
| 4550 |
* |
| 4551 |
* @param[in] ins Pointer to the decoded instruction object. |
| 4552 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 4553 |
* which caused the failure. |
| 4554 |
* @param[in] index The index (number) of the source operand. |
| 4555 |
* |
| 4556 |
* @return Src3RegFile's enumeration if the field is valid, GED_REG_FILE_INVALID otherwise. |
| 4557 |
* |
| 4558 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 4559 |
*/ |
| 4560 |
extern GED_REG_FILE GED_CALLCONV GED_GetIndexedSrcRegFile(ged_ins_t* ins, GED_RETURN_VALUE* result, const uint8_t index); |
| 4561 |
|
| 4562 |
/*! |
| 4563 |
* Set the value of the RegFile field which corresponds to an indexed Src operand in the given instruction. See @ref |
| 4564 |
* GED_INS_FIELD_Src0RegFile, @ref GED_INS_FIELD_Src1RegFile, @ref GED_INS_FIELD_Src2RegFile, @ref GED_INS_FIELD_Src3RegFile, @ref |
| 4565 |
* GED_INS_FIELD_Src4RegFile for the fields' description. |
| 4566 |
* |
| 4567 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 4568 |
* @param[in] value The value to encode. |
| 4569 |
* @param[in] index The index (number) of the source operand. |
| 4570 |
* |
| 4571 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 4572 |
*/ |
| 4573 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetIndexedSrcRegFile(ged_ins_t* ins, const GED_REG_FILE value, const uint8_t index); |
| 4574 |
|
| 4575 |
/*! |
| 4576 |
* Get the value of the RegNum field which corresponds to an indexed Src operand in the given instruction. See @ref |
| 4577 |
* GED_INS_FIELD_Src0RegNum, @ref GED_INS_FIELD_Src1RegNum, @ref GED_INS_FIELD_Src2RegNum, @ref GED_INS_FIELD_Src3RegNum, @ref |
| 4578 |
* GED_INS_FIELD_Src4RegNum for the fields' description. |
| 4579 |
* |
| 4580 |
* @param[in] ins Pointer to the decoded instruction object. |
| 4581 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 4582 |
* which caused the failure. |
| 4583 |
* @param[in] index The index (number) of the source operand. |
| 4584 |
* |
| 4585 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 4586 |
* it is important to check the GED_RETURN_VALUE result. |
| 4587 |
* |
| 4588 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 4589 |
*/ |
| 4590 |
extern uint32_t GED_CALLCONV GED_GetIndexedSrcRegNum(ged_ins_t* ins, GED_RETURN_VALUE* result, const uint8_t index); |
| 4591 |
|
| 4592 |
/*! |
| 4593 |
* Set the value of the RegNum field which corresponds to an indexed Src operand in the given instruction. See @ref |
| 4594 |
* GED_INS_FIELD_Src0RegNum, @ref GED_INS_FIELD_Src1RegNum, @ref GED_INS_FIELD_Src2RegNum, @ref GED_INS_FIELD_Src3RegNum, @ref |
| 4595 |
* GED_INS_FIELD_Src4RegNum for the fields' description. |
| 4596 |
* |
| 4597 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 4598 |
* @param[in] value The value to encode. |
| 4599 |
* @param[in] index The index (number) of the source operand. |
| 4600 |
* |
| 4601 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 4602 |
*/ |
| 4603 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetIndexedSrcRegNum(ged_ins_t* ins, const uint32_t value, const uint8_t index); |
| 4604 |
|
| 4605 |
/*! |
| 4606 |
* Get the value of the RepCtrl field which corresponds to an indexed Src operand in the given instruction. See @ref |
| 4607 |
* GED_INS_FIELD_Src0RepCtrl, @ref GED_INS_FIELD_Src1RepCtrl, @ref GED_INS_FIELD_Src2RepCtrl for the fields' description. |
| 4608 |
* |
| 4609 |
* @param[in] ins Pointer to the decoded instruction object. |
| 4610 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 4611 |
* which caused the failure. |
| 4612 |
* @param[in] index The index (number) of the source operand. |
| 4613 |
* |
| 4614 |
* @return Src3RegFile's enumeration if the field is valid, GED_REG_FILE_INVALID otherwise. |
| 4615 |
* |
| 4616 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 4617 |
*/ |
| 4618 |
extern GED_REP_CTRL GED_CALLCONV GED_GetIndexedSrcRepCtrl(ged_ins_t* ins, GED_RETURN_VALUE* result, const uint8_t index); |
| 4619 |
|
| 4620 |
/*! |
| 4621 |
* Set the value of the RepCtrl field which corresponds to an indexed Src operand in the given instruction. See @ref |
| 4622 |
* GED_INS_FIELD_Src0RepCtrl, @ref GED_INS_FIELD_Src1RepCtrl, @ref GED_INS_FIELD_Src2RepCtrl for the fields' description. |
| 4623 |
* |
| 4624 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 4625 |
* @param[in] value The value to encode. |
| 4626 |
* @param[in] index The index (number) of the source operand. |
| 4627 |
* |
| 4628 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 4629 |
*/ |
| 4630 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetIndexedSrcRepCtrl(ged_ins_t* ins, const GED_REP_CTRL value, const uint8_t index); |
| 4631 |
|
| 4632 |
/*! |
| 4633 |
* Get the value of the SrcMod field which corresponds to an indexed Src operand in the given instruction. See @ref |
| 4634 |
* GED_INS_FIELD_Src0SrcMod, @ref GED_INS_FIELD_Src1SrcMod, @ref GED_INS_FIELD_Src2SrcMod for the fields' description. |
| 4635 |
* |
| 4636 |
* @param[in] ins Pointer to the decoded instruction object. |
| 4637 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 4638 |
* which caused the failure. |
| 4639 |
* @param[in] index The index (number) of the source operand. |
| 4640 |
* |
| 4641 |
* @return Src3RegFile's enumeration if the field is valid, GED_REG_FILE_INVALID otherwise. |
| 4642 |
* |
| 4643 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 4644 |
*/ |
| 4645 |
extern GED_SRC_MOD GED_CALLCONV GED_GetIndexedSrcSrcMod(ged_ins_t* ins, GED_RETURN_VALUE* result, const uint8_t index); |
| 4646 |
|
| 4647 |
/*! |
| 4648 |
* Set the value of the SrcMod field which corresponds to an indexed Src operand in the given instruction. See @ref |
| 4649 |
* GED_INS_FIELD_Src0SrcMod, @ref GED_INS_FIELD_Src1SrcMod, @ref GED_INS_FIELD_Src2SrcMod for the fields' description. |
| 4650 |
* |
| 4651 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 4652 |
* @param[in] value The value to encode. |
| 4653 |
* @param[in] index The index (number) of the source operand. |
| 4654 |
* |
| 4655 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 4656 |
*/ |
| 4657 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetIndexedSrcSrcMod(ged_ins_t* ins, const GED_SRC_MOD value, const uint8_t index); |
| 4658 |
|
| 4659 |
/*! |
| 4660 |
* Get the value of the SubRegNum field which corresponds to an indexed Src operand in the given instruction. See @ref |
| 4661 |
* GED_INS_FIELD_Src0SubRegNum, @ref GED_INS_FIELD_Src1SubRegNum, @ref GED_INS_FIELD_Src2SubRegNum, @ref GED_INS_FIELD_Src3SubRegNum, |
| 4662 |
* @ref GED_INS_FIELD_Src4SubRegNum for the fields' description. |
| 4663 |
* |
| 4664 |
* @param[in] ins Pointer to the decoded instruction object. |
| 4665 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 4666 |
* which caused the failure. |
| 4667 |
* @param[in] index The index (number) of the source operand. |
| 4668 |
* |
| 4669 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 4670 |
* it is important to check the GED_RETURN_VALUE result. |
| 4671 |
* |
| 4672 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 4673 |
*/ |
| 4674 |
extern uint32_t GED_CALLCONV GED_GetIndexedSrcSubRegNum(ged_ins_t* ins, GED_RETURN_VALUE* result, const uint8_t index); |
| 4675 |
|
| 4676 |
/*! |
| 4677 |
* Set the value of the SubRegNum field which corresponds to an indexed Src operand in the given instruction. See @ref |
| 4678 |
* GED_INS_FIELD_Src0SubRegNum, @ref GED_INS_FIELD_Src1SubRegNum, @ref GED_INS_FIELD_Src2SubRegNum, @ref GED_INS_FIELD_Src3SubRegNum, |
| 4679 |
* @ref GED_INS_FIELD_Src4SubRegNum for the fields' description. |
| 4680 |
* |
| 4681 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 4682 |
* @param[in] value The value to encode. |
| 4683 |
* @param[in] index The index (number) of the source operand. |
| 4684 |
* |
| 4685 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 4686 |
*/ |
| 4687 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetIndexedSrcSubRegNum(ged_ins_t* ins, const uint32_t value, const uint8_t index); |
| 4688 |
|
| 4689 |
/*! |
| 4690 |
* Get the value of the SubRegNumByte field which corresponds to an indexed Src operand in the given instruction. See @ref |
| 4691 |
* GED_INS_FIELD_Src0SubRegNumByte for the fields' description. |
| 4692 |
* |
| 4693 |
* @param[in] ins Pointer to the decoded instruction object. |
| 4694 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 4695 |
* which caused the failure. |
| 4696 |
* @param[in] index The index (number) of the source operand. |
| 4697 |
* |
| 4698 |
* @return The requested value if the field is valid, uint32_t equivalent of -1 otherwise. If -1 is a valid value for this field, |
| 4699 |
* it is important to check the GED_RETURN_VALUE result. |
| 4700 |
* |
| 4701 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 4702 |
*/ |
| 4703 |
extern uint32_t GED_CALLCONV GED_GetIndexedSrcSubRegNumByte(ged_ins_t* ins, GED_RETURN_VALUE* result, const uint8_t index); |
| 4704 |
|
| 4705 |
/*! |
| 4706 |
* Set the value of the SubRegNumByte field which corresponds to an indexed Src operand in the given instruction. See @ref |
| 4707 |
* GED_INS_FIELD_Src0SubRegNumByte for the fields' description. |
| 4708 |
* |
| 4709 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 4710 |
* @param[in] value The value to encode. |
| 4711 |
* @param[in] index The index (number) of the source operand. |
| 4712 |
* |
| 4713 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 4714 |
*/ |
| 4715 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetIndexedSrcSubRegNumByte(ged_ins_t* ins, const uint32_t value, const uint8_t index); |
| 4716 |
|
| 4717 |
/*! |
| 4718 |
* Get the value of the VertStride field which corresponds to an indexed Src operand in the given instruction. See @ref |
| 4719 |
* GED_INS_FIELD_Src0VertStride, @ref GED_INS_FIELD_Src1VertStride, @ref GED_INS_FIELD_Src2VertStride for the fields' description. |
| 4720 |
* |
| 4721 |
* @param[in] ins Pointer to the decoded instruction object. |
| 4722 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 4723 |
* which caused the failure. |
| 4724 |
* @param[in] index The index (number) of the source operand. |
| 4725 |
* |
| 4726 |
* @return The requested value upon success. If the encoded value is not valid, i.e. does not map to any valid enumerated value |
| 4727 |
* for this instruction, the (invalid) encoded value is returned. If the field is not valid for the instruction, the |
| 4728 |
* uint32_t equivalent of -1 is returned. If -1 is a valid value for this field, it is important to check the |
| 4729 |
* GED_RETURN_VALUE result. |
| 4730 |
* |
| 4731 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 4732 |
*/ |
| 4733 |
extern uint32_t GED_CALLCONV GED_GetIndexedSrcVertStride(ged_ins_t* ins, GED_RETURN_VALUE* result, const uint8_t index); |
| 4734 |
|
| 4735 |
/*! |
| 4736 |
* Set the value of the VertStride field which corresponds to an indexed Src operand in the given instruction. See @ref |
| 4737 |
* GED_INS_FIELD_Src0VertStride, @ref GED_INS_FIELD_Src1VertStride, @ref GED_INS_FIELD_Src2VertStride for the fields' description. |
| 4738 |
* |
| 4739 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 4740 |
* @param[in] value The value to encode. |
| 4741 |
* @param[in] index The index (number) of the source operand. |
| 4742 |
* |
| 4743 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 4744 |
*/ |
| 4745 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetIndexedSrcVertStride(ged_ins_t* ins, const uint32_t value, const uint8_t index); |
| 4746 |
|
| 4747 |
/*! |
| 4748 |
* Get the value of the Width field which corresponds to an indexed Src operand in the given instruction. See @ref |
| 4749 |
* GED_INS_FIELD_Src0Width, @ref GED_INS_FIELD_Src1Width for the fields' description. |
| 4750 |
* |
| 4751 |
* @param[in] ins Pointer to the decoded instruction object. |
| 4752 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific error |
| 4753 |
* which caused the failure. |
| 4754 |
* @param[in] index The index (number) of the source operand. |
| 4755 |
* |
| 4756 |
* @return The requested value upon success. If the encoded value is not valid, i.e. does not map to any valid enumerated value |
| 4757 |
* for this instruction, the (invalid) encoded value is returned. If the field is not valid for the instruction, the |
| 4758 |
* uint32_t equivalent of -1 is returned. If -1 is a valid value for this field, it is important to check the |
| 4759 |
* GED_RETURN_VALUE result. |
| 4760 |
* |
| 4761 |
* @note @ref GED_DecodeIns must be called with the given instruction before calling this function. |
| 4762 |
*/ |
| 4763 |
extern uint32_t GED_CALLCONV GED_GetIndexedSrcWidth(ged_ins_t* ins, GED_RETURN_VALUE* result, const uint8_t index); |
| 4764 |
|
| 4765 |
/*! |
| 4766 |
* Set the value of the Width field which corresponds to an indexed Src operand in the given instruction. See @ref |
| 4767 |
* GED_INS_FIELD_Src0Width, @ref GED_INS_FIELD_Src1Width for the fields' description. |
| 4768 |
* |
| 4769 |
* @param[in,out] ins Pointer to the instruction object for encoding. |
| 4770 |
* @param[in] value The value to encode. |
| 4771 |
* @param[in] index The index (number) of the source operand. |
| 4772 |
* |
| 4773 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 4774 |
*/ |
| 4775 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetIndexedSrcWidth(ged_ins_t* ins, const uint32_t value, const uint8_t index); |
| 4776 |
|
| 4777 |
/*! |
| 4778 |
* Get the value of the ArchReg field from the given register number (as obtained by @ref GED_GetDstRegNum, @ref GED_GetSrc0RegNum or |
| 4779 |
* @ref GED_GetSrc1RegNum). The function returns an enumeration value. To obtain the enum entry's string representation, use @ref |
| 4780 |
* GED_GetArchRegString. See @ref GED_PSEUDO_FIELD_ArchReg for the field's description. |
| 4781 |
* |
| 4782 |
* @param[in] regNum The register number. |
| 4783 |
* @param[in] modelId The GED model by which to interpret. |
| 4784 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific |
| 4785 |
* error which caused the failure. |
| 4786 |
* |
| 4787 |
* @return ArchReg's enumeration if the field is valid, GED_ARCH_REG_INVALID otherwise. |
| 4788 |
*/ |
| 4789 |
extern GED_ARCH_REG GED_CALLCONV GED_GetArchReg(const uint32_t regNum, const GED_MODEL modelId, GED_RETURN_VALUE* result); |
| 4790 |
|
| 4791 |
/*! |
| 4792 |
* Set the value of the ArchReg field in the given register number. The latter can then be set to its appropriate fields (@ref |
| 4793 |
* GED_SetDstRegNum, @ref GED_SetSrc0RegNum or @ref GED_SetSrc1RegNum). See @ref GED_PSEUDO_FIELD_ArchReg for the field's description. |
| 4794 |
* |
| 4795 |
* @param[in,out] regNum The register number. |
| 4796 |
* @param[in] modelId The GED model by which to interpret. |
| 4797 |
* @param[in] archReg The architectural register. |
| 4798 |
* |
| 4799 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 4800 |
*/ |
| 4801 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetArchReg(uint32_t* regNum, const GED_MODEL modelId, const GED_ARCH_REG archReg); |
| 4802 |
|
| 4803 |
/*! |
| 4804 |
* Get the value of the ArchRegNum field from the given register number (as obtained by @ref GED_GetDstRegNum, @ref GED_GetSrc0RegNum |
| 4805 |
* or @ref GED_GetSrc1RegNum). See @ref GED_PSEUDO_FIELD_ArchRegNum for the field's description. |
| 4806 |
* |
| 4807 |
* @param[in] regNum The register number. |
| 4808 |
* @param[in] modelId The GED model by which to interpret. |
| 4809 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific |
| 4810 |
* error which caused the failure. |
| 4811 |
* |
| 4812 |
* @return The architectural register number if the field is valid, the unchanged regNum value otherwise. |
| 4813 |
*/ |
| 4814 |
extern uint32_t GED_CALLCONV GED_GetArchRegNum(const uint32_t regNum, const GED_MODEL modelId, GED_RETURN_VALUE* result); |
| 4815 |
|
| 4816 |
/*! |
| 4817 |
* Set the value of the ArchRegNum field in the given register number. The latter can then be set to its appropriate fields (@ref |
| 4818 |
* GED_SetDstRegNum, @ref GED_SetSrc0RegNum or @ref GED_SetSrc1RegNum). See @ref GED_PSEUDO_FIELD_ArchRegNum for the field's |
| 4819 |
* description. |
| 4820 |
* |
| 4821 |
* @param[in,out] regNum The register number. |
| 4822 |
* @param[in] modelId The GED model by which to interpret. |
| 4823 |
* @param[in] archRegNum The architectural register number. |
| 4824 |
* |
| 4825 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 4826 |
*/ |
| 4827 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetArchRegNum(uint32_t* regNum, const GED_MODEL modelId, const uint32_t archRegNum); |
| 4828 |
|
| 4829 |
/*! |
| 4830 |
* Get the value of the SwizzleX field from the given channel select (as obtained by @ref GED_GetSrc0ChanSel, @ref GED_GetSrc1ChanSel |
| 4831 |
* or @ref GED_GetSrc2ChanSel). The function returns an enumeration value. To obtain the enum entry's string representation, use @ref |
| 4832 |
* GED_GetSwizzleString. See @ref GED_PSEUDO_FIELD_SwizzleX for the field's description. |
| 4833 |
* |
| 4834 |
* @param[in] chanSel The channel select. |
| 4835 |
* @param[in] modelId The GED model by which to interpret. |
| 4836 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific |
| 4837 |
* error which caused the failure. |
| 4838 |
* |
| 4839 |
* @return SwizzleX's enumeration if the field is valid, GED_SWIZZLE_INVALID otherwise. |
| 4840 |
*/ |
| 4841 |
extern GED_SWIZZLE GED_CALLCONV GED_GetSwizzleX(const uint32_t chanSel, const GED_MODEL modelId, GED_RETURN_VALUE* result); |
| 4842 |
|
| 4843 |
/*! |
| 4844 |
* Set the value of the SwizzleX field in the given channel select. The latter can then be set to its appropriate fields (@ref |
| 4845 |
* GED_SetSrc0ChanSel, @ref GED_SetSrc1ChanSel or @ref GED_SetSrc2ChanSel). See @ref GED_PSEUDO_FIELD_SwizzleX for the field's |
| 4846 |
* description. |
| 4847 |
* |
| 4848 |
* @param[in,out] chanSel The channel select. |
| 4849 |
* @param[in] modelId The GED model by which to interpret. |
| 4850 |
* @param[in] swizzle The swizzle value. |
| 4851 |
* |
| 4852 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 4853 |
*/ |
| 4854 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSwizzleX(uint32_t* chanSel, const GED_MODEL modelId, const GED_SWIZZLE swizzle); |
| 4855 |
|
| 4856 |
/*! |
| 4857 |
* Get the value of the SwizzleY field from the given channel select (as obtained by @ref GED_GetSrc0ChanSel, @ref GED_GetSrc1ChanSel |
| 4858 |
* or @ref GED_GetSrc2ChanSel). The function returns an enumeration value. To obtain the enum entry's string representation, use @ref |
| 4859 |
* GED_GetSwizzleString. See @ref GED_PSEUDO_FIELD_SwizzleY for the field's description. |
| 4860 |
* |
| 4861 |
* @param[in] chanSel The channel select. |
| 4862 |
* @param[in] modelId The GED model by which to interpret. |
| 4863 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific |
| 4864 |
* error which caused the failure. |
| 4865 |
* |
| 4866 |
* @return SwizzleY's enumeration if the field is valid, GED_SWIZZLE_INVALID otherwise. |
| 4867 |
*/ |
| 4868 |
extern GED_SWIZZLE GED_CALLCONV GED_GetSwizzleY(const uint32_t chanSel, const GED_MODEL modelId, GED_RETURN_VALUE* result); |
| 4869 |
|
| 4870 |
/*! |
| 4871 |
* Set the value of the SwizzleY field in the given channel select. The latter can then be set to its appropriate fields (@ref |
| 4872 |
* GED_SetSrc0ChanSel, @ref GED_SetSrc1ChanSel or @ref GED_SetSrc2ChanSel). See @ref GED_PSEUDO_FIELD_SwizzleY for the field's |
| 4873 |
* description. |
| 4874 |
* |
| 4875 |
* @param[in,out] chanSel The channel select. |
| 4876 |
* @param[in] modelId The GED model by which to interpret. |
| 4877 |
* @param[in] swizzle The swizzle value. |
| 4878 |
* |
| 4879 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 4880 |
*/ |
| 4881 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSwizzleY(uint32_t* chanSel, const GED_MODEL modelId, const GED_SWIZZLE swizzle); |
| 4882 |
|
| 4883 |
/*! |
| 4884 |
* Get the value of the SwizzleZ field from the given channel select (as obtained by @ref GED_GetSrc0ChanSel, @ref GED_GetSrc1ChanSel |
| 4885 |
* or @ref GED_GetSrc2ChanSel). The function returns an enumeration value. To obtain the enum entry's string representation, use @ref |
| 4886 |
* GED_GetSwizzleString. See @ref GED_PSEUDO_FIELD_SwizzleZ for the field's description. |
| 4887 |
* |
| 4888 |
* @param[in] chanSel The channel select. |
| 4889 |
* @param[in] modelId The GED model by which to interpret. |
| 4890 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific |
| 4891 |
* error which caused the failure. |
| 4892 |
* |
| 4893 |
* @return SwizzleZ's enumeration if the field is valid, GED_SWIZZLE_INVALID otherwise. |
| 4894 |
*/ |
| 4895 |
extern GED_SWIZZLE GED_CALLCONV GED_GetSwizzleZ(const uint32_t chanSel, const GED_MODEL modelId, GED_RETURN_VALUE* result); |
| 4896 |
|
| 4897 |
/*! |
| 4898 |
* Set the value of the SwizzleZ field in the given channel select. The latter can then be set to its appropriate fields (@ref |
| 4899 |
* GED_SetSrc0ChanSel, @ref GED_SetSrc1ChanSel or @ref GED_SetSrc2ChanSel). See @ref GED_PSEUDO_FIELD_SwizzleZ for the field's |
| 4900 |
* description. |
| 4901 |
* |
| 4902 |
* @param[in,out] chanSel The channel select. |
| 4903 |
* @param[in] modelId The GED model by which to interpret. |
| 4904 |
* @param[in] swizzle The swizzle value. |
| 4905 |
* |
| 4906 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 4907 |
*/ |
| 4908 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSwizzleZ(uint32_t* chanSel, const GED_MODEL modelId, const GED_SWIZZLE swizzle); |
| 4909 |
|
| 4910 |
/*! |
| 4911 |
* Get the value of the SwizzleW field from the given channel select (as obtained by @ref GED_GetSrc0ChanSel, @ref GED_GetSrc1ChanSel |
| 4912 |
* or @ref GED_GetSrc2ChanSel). The function returns an enumeration value. To obtain the enum entry's string representation, use @ref |
| 4913 |
* GED_GetSwizzleString. See @ref GED_PSEUDO_FIELD_SwizzleW for the field's description. |
| 4914 |
* |
| 4915 |
* @param[in] chanSel The channel select. |
| 4916 |
* @param[in] modelId The GED model by which to interpret. |
| 4917 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific |
| 4918 |
* error which caused the failure. |
| 4919 |
* |
| 4920 |
* @return SwizzleW's enumeration if the field is valid, GED_SWIZZLE_INVALID otherwise. |
| 4921 |
*/ |
| 4922 |
extern GED_SWIZZLE GED_CALLCONV GED_GetSwizzleW(const uint32_t chanSel, const GED_MODEL modelId, GED_RETURN_VALUE* result); |
| 4923 |
|
| 4924 |
/*! |
| 4925 |
* Set the value of the SwizzleW field in the given channel select. The latter can then be set to its appropriate fields (@ref |
| 4926 |
* GED_SetSrc0ChanSel, @ref GED_SetSrc1ChanSel or @ref GED_SetSrc2ChanSel). See @ref GED_PSEUDO_FIELD_SwizzleW for the field's |
| 4927 |
* description. |
| 4928 |
* |
| 4929 |
* @param[in,out] chanSel The channel select. |
| 4930 |
* @param[in] modelId The GED model by which to interpret. |
| 4931 |
* @param[in] swizzle The swizzle value. |
| 4932 |
* |
| 4933 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 4934 |
*/ |
| 4935 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSwizzleW(uint32_t* chanSel, const GED_MODEL modelId, const GED_SWIZZLE swizzle); |
| 4936 |
|
| 4937 |
/*! |
| 4938 |
* Get the value of the MessageLength field from the given message descriptor (as obtained by @ref GED_GetMsgDesc). See @ref |
| 4939 |
* GED_PSEUDO_FIELD_MessageLength for the field's description. |
| 4940 |
* |
| 4941 |
* @param[in] msgDesc The message descriptor. |
| 4942 |
* @param[in] modelId The GED model by which to interpret. |
| 4943 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific |
| 4944 |
* error which caused the failure. |
| 4945 |
* |
| 4946 |
* @return The message length if the field is valid, the unchanged msgDesc value otherwise. |
| 4947 |
*/ |
| 4948 |
extern uint32_t GED_CALLCONV GED_GetMessageLength(const uint32_t msgDesc, const GED_MODEL modelId, GED_RETURN_VALUE* result); |
| 4949 |
|
| 4950 |
/*! |
| 4951 |
* Set the value of the MessageLength field in the given message descriptor. The latter can then be set to its appropriate field (@ref |
| 4952 |
* GED_SetMsgDesc). See @ref GED_PSEUDO_FIELD_MessageLength for the field's description. |
| 4953 |
* |
| 4954 |
* @param[in,out] msgDesc The message descriptor. |
| 4955 |
* @param[in] modelId The GED model by which to interpret. |
| 4956 |
* @param[in] length The message length. |
| 4957 |
* |
| 4958 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 4959 |
*/ |
| 4960 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetMessageLength(uint32_t* msgDesc, const GED_MODEL modelId, const uint32_t length); |
| 4961 |
|
| 4962 |
/*! |
| 4963 |
* Get the value of the ResponseLength field from the given message descriptor (as obtained by @ref GED_GetMsgDesc). See @ref |
| 4964 |
* GED_PSEUDO_FIELD_ResponseLength for the field's description. |
| 4965 |
* |
| 4966 |
* @param[in] msgDesc The message descriptor. |
| 4967 |
* @param[in] modelId The GED model by which to interpret. |
| 4968 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific |
| 4969 |
* error which caused the failure. |
| 4970 |
* |
| 4971 |
* @return The response length if the field is valid, the unchanged msgDesc value otherwise. |
| 4972 |
*/ |
| 4973 |
extern uint32_t GED_CALLCONV GED_GetResponseLength(const uint32_t msgDesc, const GED_MODEL modelId, GED_RETURN_VALUE* result); |
| 4974 |
|
| 4975 |
/*! |
| 4976 |
* Set the value of the ResponseLength field in the given message descriptor. The latter can then be set to its appropriate field |
| 4977 |
* (@ref GED_SetMsgDesc). See @ref GED_PSEUDO_FIELD_ResponseLength for the field's description. |
| 4978 |
* |
| 4979 |
* @param[in,out] msgDesc The message descriptor. |
| 4980 |
* @param[in] modelId The GED model by which to interpret. |
| 4981 |
* @param[in] length The response length. |
| 4982 |
* |
| 4983 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 4984 |
*/ |
| 4985 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetResponseLength(uint32_t* msgDesc, const GED_MODEL modelId, const uint32_t length); |
| 4986 |
|
| 4987 |
/*! |
| 4988 |
* Get the value of the HeaderPresent field from the given message descriptor (as obtained by @ref GED_GetMsgDesc). The function |
| 4989 |
* returns an enumeration value. To obtain the enum entry's string representation, use @ref GED_GetHeaderPresentString. See @ref |
| 4990 |
* GED_PSEUDO_FIELD_HeaderPresent for the field's description. |
| 4991 |
* |
| 4992 |
* @param[in] msgDesc The message descriptor. |
| 4993 |
* @param[in] modelId The GED model by which to interpret. |
| 4994 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific |
| 4995 |
* error which caused the failure. |
| 4996 |
* |
| 4997 |
* @return HeaderPresent's enumeration if the field is valid, GED_HEADER_PRESENT_INVALID otherwise. |
| 4998 |
*/ |
| 4999 |
extern GED_HEADER_PRESENT GED_CALLCONV GED_GetHeaderPresent(const uint32_t msgDesc, const GED_MODEL modelId, GED_RETURN_VALUE* |
| 5000 |
result); |
| 5001 |
|
| 5002 |
/*! |
| 5003 |
* Set the value of the HeaderPresent field in the given message descriptor. The latter can then be set to its appropriate field (@ref |
| 5004 |
* GED_SetMsgDesc). See @ref GED_PSEUDO_FIELD_HeaderPresent for the field's description. |
| 5005 |
* |
| 5006 |
* @param[in,out] msgDesc The message descriptor. |
| 5007 |
* @param[in] modelId The GED model by which to interpret. |
| 5008 |
* @param[in] headerPresent The header present. |
| 5009 |
* |
| 5010 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 5011 |
*/ |
| 5012 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetHeaderPresent(uint32_t* msgDesc, const GED_MODEL modelId, const GED_HEADER_PRESENT |
| 5013 |
headerPresent); |
| 5014 |
|
| 5015 |
/*! |
| 5016 |
* Get the value of the MessageTypeDP_SAMPLER field from the given message descriptor (as obtained by @ref GED_GetMsgDesc). The |
| 5017 |
* function returns an enumeration value. To obtain the enum entry's string representation, use @ref GED_GetMessageTypeString. See |
| 5018 |
* @ref GED_PSEUDO_FIELD_MessageTypeDP_SAMPLER for the field's description. |
| 5019 |
* |
| 5020 |
* @param[in] msgDesc The message descriptor. |
| 5021 |
* @param[in] modelId The GED model by which to interpret. |
| 5022 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific |
| 5023 |
* error which caused the failure. |
| 5024 |
* |
| 5025 |
* @return MessageTypeDP_SAMPLER's enumeration if the field is valid, GED_MESSAGE_TYPE_INVALID otherwise. |
| 5026 |
*/ |
| 5027 |
extern GED_MESSAGE_TYPE GED_CALLCONV GED_GetMessageTypeDP_SAMPLER(const uint32_t msgDesc, const GED_MODEL modelId, GED_RETURN_VALUE* |
| 5028 |
result); |
| 5029 |
|
| 5030 |
/*! |
| 5031 |
* Set the value of the MessageTypeDP_SAMPLER field in the given message descriptor. The latter can then be set to its appropriate |
| 5032 |
* field (@ref GED_SetMsgDesc). See @ref GED_PSEUDO_FIELD_MessageTypeDP_SAMPLER for the field's description. |
| 5033 |
* |
| 5034 |
* @param[in,out] msgDesc The message descriptor. |
| 5035 |
* @param[in] modelId The GED model by which to interpret. |
| 5036 |
* @param[in] messageType The data port sampler message type. |
| 5037 |
* |
| 5038 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 5039 |
*/ |
| 5040 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetMessageTypeDP_SAMPLER(uint32_t* msgDesc, const GED_MODEL modelId, const GED_MESSAGE_TYPE |
| 5041 |
messageType); |
| 5042 |
|
| 5043 |
/*! |
| 5044 |
* Get the value of the MessageTypeDP_RC field from the given message descriptor (as obtained by @ref GED_GetMsgDesc). The function |
| 5045 |
* returns an enumeration value. To obtain the enum entry's string representation, use @ref GED_GetMessageTypeString. See @ref |
| 5046 |
* GED_PSEUDO_FIELD_MessageTypeDP_RC for the field's description. |
| 5047 |
* |
| 5048 |
* @param[in] msgDesc The message descriptor. |
| 5049 |
* @param[in] modelId The GED model by which to interpret. |
| 5050 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific |
| 5051 |
* error which caused the failure. |
| 5052 |
* |
| 5053 |
* @return MessageTypeDP_RC's enumeration if the field is valid, GED_MESSAGE_TYPE_INVALID otherwise. |
| 5054 |
*/ |
| 5055 |
extern GED_MESSAGE_TYPE GED_CALLCONV GED_GetMessageTypeDP_RC(const uint32_t msgDesc, const GED_MODEL modelId, GED_RETURN_VALUE* |
| 5056 |
result); |
| 5057 |
|
| 5058 |
/*! |
| 5059 |
* Set the value of the MessageTypeDP_RC field in the given message descriptor. The latter can then be set to its appropriate field |
| 5060 |
* (@ref GED_SetMsgDesc). See @ref GED_PSEUDO_FIELD_MessageTypeDP_RC for the field's description. |
| 5061 |
* |
| 5062 |
* @param[in,out] msgDesc The message descriptor. |
| 5063 |
* @param[in] modelId The GED model by which to interpret. |
| 5064 |
* @param[in] messageType The data port render cache message type. |
| 5065 |
* |
| 5066 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 5067 |
*/ |
| 5068 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetMessageTypeDP_RC(uint32_t* msgDesc, const GED_MODEL modelId, const GED_MESSAGE_TYPE |
| 5069 |
messageType); |
| 5070 |
|
| 5071 |
/*! |
| 5072 |
* Get the value of the MessageTypeDP_CC field from the given message descriptor (as obtained by @ref GED_GetMsgDesc). The function |
| 5073 |
* returns an enumeration value. To obtain the enum entry's string representation, use @ref GED_GetMessageTypeString. See @ref |
| 5074 |
* GED_PSEUDO_FIELD_MessageTypeDP_CC for the field's description. |
| 5075 |
* |
| 5076 |
* @param[in] msgDesc The message descriptor. |
| 5077 |
* @param[in] modelId The GED model by which to interpret. |
| 5078 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific |
| 5079 |
* error which caused the failure. |
| 5080 |
* |
| 5081 |
* @return MessageTypeDP_CC's enumeration if the field is valid, GED_MESSAGE_TYPE_INVALID otherwise. |
| 5082 |
*/ |
| 5083 |
extern GED_MESSAGE_TYPE GED_CALLCONV GED_GetMessageTypeDP_CC(const uint32_t msgDesc, const GED_MODEL modelId, GED_RETURN_VALUE* |
| 5084 |
result); |
| 5085 |
|
| 5086 |
/*! |
| 5087 |
* Set the value of the MessageTypeDP_CC field in the given message descriptor. The latter can then be set to its appropriate field |
| 5088 |
* (@ref GED_SetMsgDesc). See @ref GED_PSEUDO_FIELD_MessageTypeDP_CC for the field's description. |
| 5089 |
* |
| 5090 |
* @param[in,out] msgDesc The message descriptor. |
| 5091 |
* @param[in] modelId The GED model by which to interpret. |
| 5092 |
* @param[in] messageType The data port constant cache message type. |
| 5093 |
* |
| 5094 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 5095 |
*/ |
| 5096 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetMessageTypeDP_CC(uint32_t* msgDesc, const GED_MODEL modelId, const GED_MESSAGE_TYPE |
| 5097 |
messageType); |
| 5098 |
|
| 5099 |
/*! |
| 5100 |
* Get the value of the MessageTypeDP_DC0 field from the given message descriptor (as obtained by @ref GED_GetMsgDesc). The function |
| 5101 |
* returns an enumeration value. To obtain the enum entry's string representation, use @ref GED_GetMessageTypeString. See @ref |
| 5102 |
* GED_PSEUDO_FIELD_MessageTypeDP_DC0 for the field's description. |
| 5103 |
* |
| 5104 |
* @param[in] msgDesc The message descriptor. |
| 5105 |
* @param[in] modelId The GED model by which to interpret. |
| 5106 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific |
| 5107 |
* error which caused the failure. |
| 5108 |
* |
| 5109 |
* @return MessageTypeDP_DC0's enumeration if the field is valid, GED_MESSAGE_TYPE_INVALID otherwise. |
| 5110 |
*/ |
| 5111 |
extern GED_MESSAGE_TYPE GED_CALLCONV GED_GetMessageTypeDP_DC0(const uint32_t msgDesc, const GED_MODEL modelId, GED_RETURN_VALUE* |
| 5112 |
result); |
| 5113 |
|
| 5114 |
/*! |
| 5115 |
* Set the value of the MessageTypeDP_DC0 field in the given message descriptor. The latter can then be set to its appropriate field |
| 5116 |
* (@ref GED_SetMsgDesc). See @ref GED_PSEUDO_FIELD_MessageTypeDP_DC0 for the field's description. |
| 5117 |
* |
| 5118 |
* @param[in,out] msgDesc The message descriptor. |
| 5119 |
* @param[in] modelId The GED model by which to interpret. |
| 5120 |
* @param[in] messageType The data port data cache 0 message type. |
| 5121 |
* |
| 5122 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 5123 |
*/ |
| 5124 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetMessageTypeDP_DC0(uint32_t* msgDesc, const GED_MODEL modelId, const GED_MESSAGE_TYPE |
| 5125 |
messageType); |
| 5126 |
|
| 5127 |
/*! |
| 5128 |
* Get the value of the TypedSurfaceSlotGroup field from the given message descriptor (as obtained by @ref GED_GetMsgDesc). The |
| 5129 |
* function returns an enumeration value. To obtain the enum entry's string representation, use @ref GED_GetSlotGroupString. See @ref |
| 5130 |
* GED_PSEUDO_FIELD_TypedSurfaceSlotGroup for the field's description. |
| 5131 |
* |
| 5132 |
* @param[in] msgDesc The message descriptor. |
| 5133 |
* @param[in] modelId The GED model by which to interpret. |
| 5134 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific |
| 5135 |
* error which caused the failure. |
| 5136 |
* |
| 5137 |
* @return TypedSurfaceSlotGroup's enumeration if the field is valid, GED_SLOT_GROUP_INVALID otherwise. |
| 5138 |
*/ |
| 5139 |
extern GED_SLOT_GROUP GED_CALLCONV GED_GetTypedSurfaceSlotGroup(const uint32_t msgDesc, const GED_MODEL modelId, GED_RETURN_VALUE* |
| 5140 |
result); |
| 5141 |
|
| 5142 |
/*! |
| 5143 |
* Set the value of the TypedSurfaceSlotGroup field in the given message descriptor. The latter can then be set to its appropriate |
| 5144 |
* field (@ref GED_SetMsgDesc). See @ref GED_PSEUDO_FIELD_TypedSurfaceSlotGroup for the field's description. |
| 5145 |
* |
| 5146 |
* @param[in,out] msgDesc The message descriptor. |
| 5147 |
* @param[in] modelId The GED model by which to interpret. |
| 5148 |
* @param[in] slotGroup The typed surface slot group. |
| 5149 |
* |
| 5150 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 5151 |
*/ |
| 5152 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetTypedSurfaceSlotGroup(uint32_t* msgDesc, const GED_MODEL modelId, const GED_SLOT_GROUP |
| 5153 |
slotGroup); |
| 5154 |
|
| 5155 |
/*! |
| 5156 |
* Get the value of the TypedAtomicSlotGroup field from the given message descriptor (as obtained by @ref GED_GetMsgDesc). The |
| 5157 |
* function returns an enumeration value. To obtain the enum entry's string representation, use @ref GED_GetSlotGroupString. See @ref |
| 5158 |
* GED_PSEUDO_FIELD_TypedAtomicSlotGroup for the field's description. |
| 5159 |
* |
| 5160 |
* @param[in] msgDesc The message descriptor. |
| 5161 |
* @param[in] modelId The GED model by which to interpret. |
| 5162 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific |
| 5163 |
* error which caused the failure. |
| 5164 |
* |
| 5165 |
* @return TypedAtomicSlotGroup's enumeration if the field is valid, GED_SLOT_GROUP_INVALID otherwise. |
| 5166 |
*/ |
| 5167 |
extern GED_SLOT_GROUP GED_CALLCONV GED_GetTypedAtomicSlotGroup(const uint32_t msgDesc, const GED_MODEL modelId, GED_RETURN_VALUE* |
| 5168 |
result); |
| 5169 |
|
| 5170 |
/*! |
| 5171 |
* Set the value of the TypedAtomicSlotGroup field in the given message descriptor. The latter can then be set to its appropriate |
| 5172 |
* field (@ref GED_SetMsgDesc). See @ref GED_PSEUDO_FIELD_TypedAtomicSlotGroup for the field's description. |
| 5173 |
* |
| 5174 |
* @param[in,out] msgDesc The message descriptor. |
| 5175 |
* @param[in] modelId The GED model by which to interpret. |
| 5176 |
* @param[in] slotGroup The typed atomic slot group. |
| 5177 |
* |
| 5178 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 5179 |
*/ |
| 5180 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetTypedAtomicSlotGroup(uint32_t* msgDesc, const GED_MODEL modelId, const GED_SLOT_GROUP |
| 5181 |
slotGroup); |
| 5182 |
|
| 5183 |
/*! |
| 5184 |
* Get the value of the UntypedSurfaceSIMDMode field from the given message descriptor (as obtained by @ref GED_GetMsgDesc). The |
| 5185 |
* function returns an enumeration value. To obtain the enum entry's string representation, use @ref GED_GetSIMDModeString. See @ref |
| 5186 |
* GED_PSEUDO_FIELD_UntypedSurfaceSIMDMode for the field's description. |
| 5187 |
* |
| 5188 |
* @param[in] msgDesc The message descriptor. |
| 5189 |
* @param[in] modelId The GED model by which to interpret. |
| 5190 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific |
| 5191 |
* error which caused the failure. |
| 5192 |
* |
| 5193 |
* @return UntypedSurfaceSIMDMode's enumeration if the field is valid, GED_SIMDMODE_INVALID otherwise. |
| 5194 |
*/ |
| 5195 |
extern GED_SIMDMODE GED_CALLCONV GED_GetUntypedSurfaceSIMDMode(const uint32_t msgDesc, const GED_MODEL modelId, GED_RETURN_VALUE* |
| 5196 |
result); |
| 5197 |
|
| 5198 |
/*! |
| 5199 |
* Set the value of the UntypedSurfaceSIMDMode field in the given message descriptor. The latter can then be set to its appropriate |
| 5200 |
* field (@ref GED_SetMsgDesc). See @ref GED_PSEUDO_FIELD_UntypedSurfaceSIMDMode for the field's description. |
| 5201 |
* |
| 5202 |
* @param[in,out] msgDesc The message descriptor. |
| 5203 |
* @param[in] modelId The GED model by which to interpret. |
| 5204 |
* @param[in] simdMode The untyped surface SIMD mode. |
| 5205 |
* |
| 5206 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 5207 |
*/ |
| 5208 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetUntypedSurfaceSIMDMode(uint32_t* msgDesc, const GED_MODEL modelId, const GED_SIMDMODE |
| 5209 |
simdMode); |
| 5210 |
|
| 5211 |
/*! |
| 5212 |
* Get the value of the UntypedAtomicSIMDMode field from the given message descriptor (as obtained by @ref GED_GetMsgDesc). The |
| 5213 |
* function returns an enumeration value. To obtain the enum entry's string representation, use @ref GED_GetSIMDModeString. See @ref |
| 5214 |
* GED_PSEUDO_FIELD_UntypedAtomicSIMDMode for the field's description. |
| 5215 |
* |
| 5216 |
* @param[in] msgDesc The message descriptor. |
| 5217 |
* @param[in] modelId The GED model by which to interpret. |
| 5218 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific |
| 5219 |
* error which caused the failure. |
| 5220 |
* |
| 5221 |
* @return UntypedAtomicSIMDMode's enumeration if the field is valid, GED_SIMDMODE_INVALID otherwise. |
| 5222 |
*/ |
| 5223 |
extern GED_SIMDMODE GED_CALLCONV GED_GetUntypedAtomicSIMDMode(const uint32_t msgDesc, const GED_MODEL modelId, GED_RETURN_VALUE* |
| 5224 |
result); |
| 5225 |
|
| 5226 |
/*! |
| 5227 |
* Set the value of the UntypedAtomicSIMDMode field in the given message descriptor. The latter can then be set to its appropriate |
| 5228 |
* field (@ref GED_SetMsgDesc). See @ref GED_PSEUDO_FIELD_UntypedAtomicSIMDMode for the field's description. |
| 5229 |
* |
| 5230 |
* @param[in,out] msgDesc The message descriptor. |
| 5231 |
* @param[in] modelId The GED model by which to interpret. |
| 5232 |
* @param[in] simdMode The untyped atomic SIMD mode. |
| 5233 |
* |
| 5234 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 5235 |
*/ |
| 5236 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetUntypedAtomicSIMDMode(uint32_t* msgDesc, const GED_MODEL modelId, const GED_SIMDMODE |
| 5237 |
simdMode); |
| 5238 |
|
| 5239 |
/*! |
| 5240 |
* Get the value of the InvalidateAfterRead field from the given message descriptor (as obtained by @ref GED_GetMsgDesc). See @ref |
| 5241 |
* GED_PSEUDO_FIELD_InvalidateAfterRead for the field's description. |
| 5242 |
* |
| 5243 |
* @param[in] msgDesc The message descriptor. |
| 5244 |
* @param[in] modelId The GED model by which to interpret. |
| 5245 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific |
| 5246 |
* error which caused the failure. |
| 5247 |
* |
| 5248 |
* @return The invalidate after read enable if the field is valid, the unchanged msgDesc value otherwise. |
| 5249 |
*/ |
| 5250 |
extern uint32_t GED_CALLCONV GED_GetInvalidateAfterRead(const uint32_t msgDesc, const GED_MODEL modelId, GED_RETURN_VALUE* result); |
| 5251 |
|
| 5252 |
/*! |
| 5253 |
* Set the value of the InvalidateAfterRead field in the given message descriptor. The latter can then be set to its appropriate field |
| 5254 |
* (@ref GED_SetMsgDesc). See @ref GED_PSEUDO_FIELD_InvalidateAfterRead for the field's description. |
| 5255 |
* |
| 5256 |
* @param[in,out] msgDesc The message descriptor. |
| 5257 |
* @param[in] modelId The GED model by which to interpret. |
| 5258 |
* @param[in] invalidateAfterReadEnable The invalidate after read enable. |
| 5259 |
* |
| 5260 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 5261 |
*/ |
| 5262 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetInvalidateAfterRead(uint32_t* msgDesc, const GED_MODEL modelId, const uint32_t |
| 5263 |
invalidateAfterReadEnable); |
| 5264 |
|
| 5265 |
/*! |
| 5266 |
* Get the value of the BlockSize field from the given message descriptor (as obtained by @ref GED_GetMsgDesc). The function returns |
| 5267 |
* an enumeration value. To obtain the enum entry's string representation, use @ref GED_GetBlockSizeString. See @ref |
| 5268 |
* GED_PSEUDO_FIELD_BlockSize for the field's description. |
| 5269 |
* |
| 5270 |
* @param[in] msgDesc The message descriptor. |
| 5271 |
* @param[in] modelId The GED model by which to interpret. |
| 5272 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific |
| 5273 |
* error which caused the failure. |
| 5274 |
* |
| 5275 |
* @return BlockSize's enumeration if the field is valid, GED_BLOCK_SIZE_INVALID otherwise. |
| 5276 |
*/ |
| 5277 |
extern GED_BLOCK_SIZE GED_CALLCONV GED_GetBlockSize(const uint32_t msgDesc, const GED_MODEL modelId, GED_RETURN_VALUE* result); |
| 5278 |
|
| 5279 |
/*! |
| 5280 |
* Set the value of the BlockSize field in the given message descriptor. The latter can then be set to its appropriate field (@ref |
| 5281 |
* GED_SetMsgDesc). See @ref GED_PSEUDO_FIELD_BlockSize for the field's description. |
| 5282 |
* |
| 5283 |
* @param[in,out] msgDesc The message descriptor. |
| 5284 |
* @param[in] modelId The GED model by which to interpret. |
| 5285 |
* @param[in] blockSize The block size. |
| 5286 |
* |
| 5287 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 5288 |
*/ |
| 5289 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetBlockSize(uint32_t* msgDesc, const GED_MODEL modelId, const GED_BLOCK_SIZE blockSize); |
| 5290 |
|
| 5291 |
/*! |
| 5292 |
* Get the value of the RedChannel field from the given message descriptor (as obtained by @ref GED_GetMsgDesc). The function returns |
| 5293 |
* an enumeration value. To obtain the enum entry's string representation, use @ref GED_GetChannelMaskString. See @ref |
| 5294 |
* GED_PSEUDO_FIELD_RedChannel for the field's description. |
| 5295 |
* |
| 5296 |
* @param[in] msgDesc The message descriptor. |
| 5297 |
* @param[in] modelId The GED model by which to interpret. |
| 5298 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific |
| 5299 |
* error which caused the failure. |
| 5300 |
* |
| 5301 |
* @return RedChannel's enumeration if the field is valid, GED_CHANNEL_MASK_INVALID otherwise. |
| 5302 |
*/ |
| 5303 |
extern GED_CHANNEL_MASK GED_CALLCONV GED_GetRedChannel(const uint32_t msgDesc, const GED_MODEL modelId, GED_RETURN_VALUE* result); |
| 5304 |
|
| 5305 |
/*! |
| 5306 |
* Set the value of the RedChannel field in the given message descriptor. The latter can then be set to its appropriate field (@ref |
| 5307 |
* GED_SetMsgDesc). See @ref GED_PSEUDO_FIELD_RedChannel for the field's description. |
| 5308 |
* |
| 5309 |
* @param[in,out] msgDesc The message descriptor. |
| 5310 |
* @param[in] modelId The GED model by which to interpret. |
| 5311 |
* @param[in] channel The red channel. |
| 5312 |
* |
| 5313 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 5314 |
*/ |
| 5315 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetRedChannel(uint32_t* msgDesc, const GED_MODEL modelId, const GED_CHANNEL_MASK channel); |
| 5316 |
|
| 5317 |
/*! |
| 5318 |
* Get the value of the GreenChannel field from the given message descriptor (as obtained by @ref GED_GetMsgDesc). The function |
| 5319 |
* returns an enumeration value. To obtain the enum entry's string representation, use @ref GED_GetChannelMaskString. See @ref |
| 5320 |
* GED_PSEUDO_FIELD_GreenChannel for the field's description. |
| 5321 |
* |
| 5322 |
* @param[in] msgDesc The message descriptor. |
| 5323 |
* @param[in] modelId The GED model by which to interpret. |
| 5324 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific |
| 5325 |
* error which caused the failure. |
| 5326 |
* |
| 5327 |
* @return GreenChannel's enumeration if the field is valid, GED_CHANNEL_MASK_INVALID otherwise. |
| 5328 |
*/ |
| 5329 |
extern GED_CHANNEL_MASK GED_CALLCONV GED_GetGreenChannel(const uint32_t msgDesc, const GED_MODEL modelId, GED_RETURN_VALUE* result); |
| 5330 |
|
| 5331 |
/*! |
| 5332 |
* Set the value of the GreenChannel field in the given message descriptor. The latter can then be set to its appropriate field (@ref |
| 5333 |
* GED_SetMsgDesc). See @ref GED_PSEUDO_FIELD_GreenChannel for the field's description. |
| 5334 |
* |
| 5335 |
* @param[in,out] msgDesc The message descriptor. |
| 5336 |
* @param[in] modelId The GED model by which to interpret. |
| 5337 |
* @param[in] channel The green channel. |
| 5338 |
* |
| 5339 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 5340 |
*/ |
| 5341 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetGreenChannel(uint32_t* msgDesc, const GED_MODEL modelId, const GED_CHANNEL_MASK channel); |
| 5342 |
|
| 5343 |
/*! |
| 5344 |
* Get the value of the BlueChannel field from the given message descriptor (as obtained by @ref GED_GetMsgDesc). The function returns |
| 5345 |
* an enumeration value. To obtain the enum entry's string representation, use @ref GED_GetChannelMaskString. See @ref |
| 5346 |
* GED_PSEUDO_FIELD_BlueChannel for the field's description. |
| 5347 |
* |
| 5348 |
* @param[in] msgDesc The message descriptor. |
| 5349 |
* @param[in] modelId The GED model by which to interpret. |
| 5350 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific |
| 5351 |
* error which caused the failure. |
| 5352 |
* |
| 5353 |
* @return BlueChannel's enumeration if the field is valid, GED_CHANNEL_MASK_INVALID otherwise. |
| 5354 |
*/ |
| 5355 |
extern GED_CHANNEL_MASK GED_CALLCONV GED_GetBlueChannel(const uint32_t msgDesc, const GED_MODEL modelId, GED_RETURN_VALUE* result); |
| 5356 |
|
| 5357 |
/*! |
| 5358 |
* Set the value of the BlueChannel field in the given message descriptor. The latter can then be set to its appropriate field (@ref |
| 5359 |
* GED_SetMsgDesc). See @ref GED_PSEUDO_FIELD_BlueChannel for the field's description. |
| 5360 |
* |
| 5361 |
* @param[in,out] msgDesc The message descriptor. |
| 5362 |
* @param[in] modelId The GED model by which to interpret. |
| 5363 |
* @param[in] channel The blue channel. |
| 5364 |
* |
| 5365 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 5366 |
*/ |
| 5367 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetBlueChannel(uint32_t* msgDesc, const GED_MODEL modelId, const GED_CHANNEL_MASK channel); |
| 5368 |
|
| 5369 |
/*! |
| 5370 |
* Get the value of the AlphaChannel field from the given message descriptor (as obtained by @ref GED_GetMsgDesc). The function |
| 5371 |
* returns an enumeration value. To obtain the enum entry's string representation, use @ref GED_GetChannelMaskString. See @ref |
| 5372 |
* GED_PSEUDO_FIELD_AlphaChannel for the field's description. |
| 5373 |
* |
| 5374 |
* @param[in] msgDesc The message descriptor. |
| 5375 |
* @param[in] modelId The GED model by which to interpret. |
| 5376 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific |
| 5377 |
* error which caused the failure. |
| 5378 |
* |
| 5379 |
* @return AlphaChannel's enumeration if the field is valid, GED_CHANNEL_MASK_INVALID otherwise. |
| 5380 |
*/ |
| 5381 |
extern GED_CHANNEL_MASK GED_CALLCONV GED_GetAlphaChannel(const uint32_t msgDesc, const GED_MODEL modelId, GED_RETURN_VALUE* result); |
| 5382 |
|
| 5383 |
/*! |
| 5384 |
* Set the value of the AlphaChannel field in the given message descriptor. The latter can then be set to its appropriate field (@ref |
| 5385 |
* GED_SetMsgDesc). See @ref GED_PSEUDO_FIELD_AlphaChannel for the field's description. |
| 5386 |
* |
| 5387 |
* @param[in,out] msgDesc The message descriptor. |
| 5388 |
* @param[in] modelId The GED model by which to interpret. |
| 5389 |
* @param[in] channel The alpha channel. |
| 5390 |
* |
| 5391 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 5392 |
*/ |
| 5393 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetAlphaChannel(uint32_t* msgDesc, const GED_MODEL modelId, const GED_CHANNEL_MASK channel); |
| 5394 |
|
| 5395 |
/*! |
| 5396 |
* Get the value of the ReturnDataControl field from the given message descriptor (as obtained by @ref GED_GetMsgDesc). The function |
| 5397 |
* returns an enumeration value. To obtain the enum entry's string representation, use @ref GED_GetReturnDataControlString. See @ref |
| 5398 |
* GED_PSEUDO_FIELD_ReturnDataControl for the field's description. |
| 5399 |
* |
| 5400 |
* @param[in] msgDesc The message descriptor. |
| 5401 |
* @param[in] modelId The GED model by which to interpret. |
| 5402 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific |
| 5403 |
* error which caused the failure. |
| 5404 |
* |
| 5405 |
* @return ReturnDataControl's enumeration if the field is valid, GED_RETURN_DATA_CONTROL_INVALID otherwise. |
| 5406 |
*/ |
| 5407 |
extern GED_RETURN_DATA_CONTROL GED_CALLCONV GED_GetReturnDataControl(const uint32_t msgDesc, const GED_MODEL modelId, |
| 5408 |
GED_RETURN_VALUE* result); |
| 5409 |
|
| 5410 |
/*! |
| 5411 |
* Set the value of the ReturnDataControl field in the given message descriptor. The latter can then be set to its appropriate field |
| 5412 |
* (@ref GED_SetMsgDesc). See @ref GED_PSEUDO_FIELD_ReturnDataControl for the field's description. |
| 5413 |
* |
| 5414 |
* @param[in,out] msgDesc The message descriptor. |
| 5415 |
* @param[in] modelId The GED model by which to interpret. |
| 5416 |
* @param[in] returnDataControl The return data control. |
| 5417 |
* |
| 5418 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 5419 |
*/ |
| 5420 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetReturnDataControl(uint32_t* msgDesc, const GED_MODEL modelId, const |
| 5421 |
GED_RETURN_DATA_CONTROL returnDataControl); |
| 5422 |
|
| 5423 |
/*! |
| 5424 |
* Get the value of the AtomicOperationType field from the given message descriptor (as obtained by @ref GED_GetMsgDesc). The function |
| 5425 |
* returns an enumeration value. To obtain the enum entry's string representation, use @ref GED_GetAtomicOperationTypeString. See @ref |
| 5426 |
* GED_PSEUDO_FIELD_AtomicOperationType for the field's description. |
| 5427 |
* |
| 5428 |
* @param[in] msgDesc The message descriptor. |
| 5429 |
* @param[in] modelId The GED model by which to interpret. |
| 5430 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific |
| 5431 |
* error which caused the failure. |
| 5432 |
* |
| 5433 |
* @return AtomicOperationType's enumeration if the field is valid, GED_ATOMIC_OPERATION_TYPE_INVALID otherwise. |
| 5434 |
*/ |
| 5435 |
extern GED_ATOMIC_OPERATION_TYPE GED_CALLCONV GED_GetAtomicOperationType(const uint32_t msgDesc, const GED_MODEL modelId, |
| 5436 |
GED_RETURN_VALUE* result); |
| 5437 |
|
| 5438 |
/*! |
| 5439 |
* Set the value of the AtomicOperationType field in the given message descriptor. The latter can then be set to its appropriate field |
| 5440 |
* (@ref GED_SetMsgDesc). See @ref GED_PSEUDO_FIELD_AtomicOperationType for the field's description. |
| 5441 |
* |
| 5442 |
* @param[in,out] msgDesc The message descriptor. |
| 5443 |
* @param[in] modelId The GED model by which to interpret. |
| 5444 |
* @param[in] operationType The atomic operation type. |
| 5445 |
* |
| 5446 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 5447 |
*/ |
| 5448 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetAtomicOperationType(uint32_t* msgDesc, const GED_MODEL modelId, const |
| 5449 |
GED_ATOMIC_OPERATION_TYPE operationType); |
| 5450 |
|
| 5451 |
/*! |
| 5452 |
* Get the value of the AtomicCounterOperationType field from the given message descriptor (as obtained by @ref GED_GetMsgDesc). The |
| 5453 |
* function returns an enumeration value. To obtain the enum entry's string representation, use @ref GED_GetAtomicOperationTypeString. |
| 5454 |
* See @ref GED_PSEUDO_FIELD_AtomicCounterOperationType for the field's description. |
| 5455 |
* |
| 5456 |
* @param[in] msgDesc The message descriptor. |
| 5457 |
* @param[in] modelId The GED model by which to interpret. |
| 5458 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific |
| 5459 |
* error which caused the failure. |
| 5460 |
* |
| 5461 |
* @return AtomicCounterOperationType's enumeration if the field is valid, GED_ATOMIC_OPERATION_TYPE_INVALID otherwise. |
| 5462 |
*/ |
| 5463 |
extern GED_ATOMIC_OPERATION_TYPE GED_CALLCONV GED_GetAtomicCounterOperationType(const uint32_t msgDesc, const GED_MODEL modelId, |
| 5464 |
GED_RETURN_VALUE* result); |
| 5465 |
|
| 5466 |
/*! |
| 5467 |
* Set the value of the AtomicCounterOperationType field in the given message descriptor. The latter can then be set to its |
| 5468 |
* appropriate field (@ref GED_SetMsgDesc). See @ref GED_PSEUDO_FIELD_AtomicCounterOperationType for the field's description. |
| 5469 |
* |
| 5470 |
* @param[in,out] msgDesc The message descriptor. |
| 5471 |
* @param[in] modelId The GED model by which to interpret. |
| 5472 |
* @param[in] operationType The atomic counter operation type. |
| 5473 |
* |
| 5474 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 5475 |
*/ |
| 5476 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetAtomicCounterOperationType(uint32_t* msgDesc, const GED_MODEL modelId, const |
| 5477 |
GED_ATOMIC_OPERATION_TYPE operationType); |
| 5478 |
|
| 5479 |
/*! |
| 5480 |
* Get the value of the SubFuncID field from the given message descriptor (as obtained by @ref GED_GetMsgDesc). The function returns |
| 5481 |
* an enumeration value. To obtain the enum entry's string representation, use @ref GED_GetSubFuncIDString. See @ref |
| 5482 |
* GED_PSEUDO_FIELD_SubFuncID for the field's description. |
| 5483 |
* |
| 5484 |
* @param[in] msgDesc The message descriptor. |
| 5485 |
* @param[in] modelId The GED model by which to interpret. |
| 5486 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific |
| 5487 |
* error which caused the failure. |
| 5488 |
* |
| 5489 |
* @return SubFuncID's enumeration if the field is valid, GED_SUB_FUNC_ID_INVALID otherwise. |
| 5490 |
*/ |
| 5491 |
extern GED_SUB_FUNC_ID GED_CALLCONV GED_GetSubFuncID(const uint32_t msgDesc, const GED_MODEL modelId, GED_RETURN_VALUE* result); |
| 5492 |
|
| 5493 |
/*! |
| 5494 |
* Set the value of the SubFuncID field in the given message descriptor. The latter can then be set to its appropriate field (@ref |
| 5495 |
* GED_SetMsgDesc). See @ref GED_PSEUDO_FIELD_SubFuncID for the field's description. |
| 5496 |
* |
| 5497 |
* @param[in,out] msgDesc The message descriptor. |
| 5498 |
* @param[in] modelId The GED model by which to interpret. |
| 5499 |
* @param[in] subFuncID The sub function. |
| 5500 |
* |
| 5501 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 5502 |
*/ |
| 5503 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetSubFuncID(uint32_t* msgDesc, const GED_MODEL modelId, const GED_SUB_FUNC_ID subFuncID); |
| 5504 |
|
| 5505 |
/*! |
| 5506 |
* Get the value of the BindingTableIndex field from the given message descriptor (as obtained by @ref GED_GetMsgDesc). See @ref |
| 5507 |
* GED_PSEUDO_FIELD_BindingTableIndex for the field's description. |
| 5508 |
* |
| 5509 |
* @param[in] msgDesc The message descriptor. |
| 5510 |
* @param[in] modelId The GED model by which to interpret. |
| 5511 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific |
| 5512 |
* error which caused the failure. |
| 5513 |
* |
| 5514 |
* @return The binding table index if the field is valid, the unchanged msgDesc value otherwise. |
| 5515 |
*/ |
| 5516 |
extern uint32_t GED_CALLCONV GED_GetBindingTableIndex(const uint32_t msgDesc, const GED_MODEL modelId, GED_RETURN_VALUE* result); |
| 5517 |
|
| 5518 |
/*! |
| 5519 |
* Set the value of the BindingTableIndex field in the given message descriptor. The latter can then be set to its appropriate field |
| 5520 |
* (@ref GED_SetMsgDesc). See @ref GED_PSEUDO_FIELD_BindingTableIndex for the field's description. |
| 5521 |
* |
| 5522 |
* @param[in,out] msgDesc The message descriptor. |
| 5523 |
* @param[in] modelId The GED model by which to interpret. |
| 5524 |
* @param[in] bti The binding table index. |
| 5525 |
* |
| 5526 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 5527 |
*/ |
| 5528 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetBindingTableIndex(uint32_t* msgDesc, const GED_MODEL modelId, const uint32_t bti); |
| 5529 |
|
| 5530 |
/*! |
| 5531 |
* Get the value of the FuncControl field from the given message descriptor (as obtained by @ref GED_GetMsgDesc). See @ref |
| 5532 |
* GED_PSEUDO_FIELD_FuncControl for the field's description. |
| 5533 |
* |
| 5534 |
* @param[in] msgDesc The message descriptor. |
| 5535 |
* @param[in] modelId The GED model by which to interpret. |
| 5536 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific |
| 5537 |
* error which caused the failure. |
| 5538 |
* |
| 5539 |
* @return The function control if the field is valid, the unchanged msgDesc value otherwise. |
| 5540 |
*/ |
| 5541 |
extern uint32_t GED_CALLCONV GED_GetFuncControl(const uint32_t msgDesc, const GED_MODEL modelId, GED_RETURN_VALUE* result); |
| 5542 |
|
| 5543 |
/*! |
| 5544 |
* Set the value of the FuncControl field in the given message descriptor. The latter can then be set to its appropriate field (@ref |
| 5545 |
* GED_SetMsgDesc). See @ref GED_PSEUDO_FIELD_FuncControl for the field's description. |
| 5546 |
* |
| 5547 |
* @param[in,out] msgDesc The message descriptor. |
| 5548 |
* @param[in] modelId The GED model by which to interpret. |
| 5549 |
* @param[in] fc The function control. |
| 5550 |
* |
| 5551 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 5552 |
*/ |
| 5553 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetFuncControl(uint32_t* msgDesc, const GED_MODEL modelId, const uint32_t fc); |
| 5554 |
|
| 5555 |
/*! |
| 5556 |
* Get the value of the MessageTypeDP_DC1 field from the given message descriptor (as obtained by @ref GED_GetMsgDesc). The function |
| 5557 |
* returns an enumeration value. To obtain the enum entry's string representation, use @ref GED_GetMessageTypeString. See @ref |
| 5558 |
* GED_PSEUDO_FIELD_MessageTypeDP_DC1 for the field's description. |
| 5559 |
* |
| 5560 |
* @param[in] msgDesc The message descriptor. |
| 5561 |
* @param[in] modelId The GED model by which to interpret. |
| 5562 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific |
| 5563 |
* error which caused the failure. |
| 5564 |
* |
| 5565 |
* @return MessageTypeDP_DC1's enumeration if the field is valid, GED_MESSAGE_TYPE_INVALID otherwise. |
| 5566 |
*/ |
| 5567 |
extern GED_MESSAGE_TYPE GED_CALLCONV GED_GetMessageTypeDP_DC1(const uint32_t msgDesc, const GED_MODEL modelId, GED_RETURN_VALUE* |
| 5568 |
result); |
| 5569 |
|
| 5570 |
/*! |
| 5571 |
* Set the value of the MessageTypeDP_DC1 field in the given message descriptor. The latter can then be set to its appropriate field |
| 5572 |
* (@ref GED_SetMsgDesc). See @ref GED_PSEUDO_FIELD_MessageTypeDP_DC1 for the field's description. |
| 5573 |
* |
| 5574 |
* @param[in,out] msgDesc The message descriptor. |
| 5575 |
* @param[in] modelId The GED model by which to interpret. |
| 5576 |
* @param[in] messageType The data port data cache 1 message type. |
| 5577 |
* |
| 5578 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 5579 |
*/ |
| 5580 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetMessageTypeDP_DC1(uint32_t* msgDesc, const GED_MODEL modelId, const GED_MESSAGE_TYPE |
| 5581 |
messageType); |
| 5582 |
|
| 5583 |
/*! |
| 5584 |
* Get the value of the MessageTypeDP0Category field from the given message descriptor (as obtained by @ref GED_GetMsgDesc). See @ref |
| 5585 |
* GED_PSEUDO_FIELD_MessageTypeDP0Category for the field's description. |
| 5586 |
* |
| 5587 |
* @param[in] msgDesc The message descriptor. |
| 5588 |
* @param[in] modelId The GED model by which to interpret. |
| 5589 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific |
| 5590 |
* error which caused the failure. |
| 5591 |
* |
| 5592 |
* @return The category of the data cache data port 0 message if the field is valid, the unchanged msgDesc value otherwise. |
| 5593 |
*/ |
| 5594 |
extern uint32_t GED_CALLCONV GED_GetMessageTypeDP0Category(const uint32_t msgDesc, const GED_MODEL modelId, GED_RETURN_VALUE* result); |
| 5595 |
|
| 5596 |
/*! |
| 5597 |
* Set the value of the MessageTypeDP0Category field in the given message descriptor. The latter can then be set to its appropriate |
| 5598 |
* field (@ref GED_SetMsgDesc). See @ref GED_PSEUDO_FIELD_MessageTypeDP0Category for the field's description. |
| 5599 |
* |
| 5600 |
* @param[in,out] msgDesc The message descriptor. |
| 5601 |
* @param[in] modelId The GED model by which to interpret. |
| 5602 |
* @param[in] category The category of the data cache data port 0 message. |
| 5603 |
* |
| 5604 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 5605 |
*/ |
| 5606 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetMessageTypeDP0Category(uint32_t* msgDesc, const GED_MODEL modelId, const uint32_t |
| 5607 |
category); |
| 5608 |
|
| 5609 |
/*! |
| 5610 |
* Get the value of the MessageTypeDP_DC0Legacy field from the given message descriptor (as obtained by @ref GED_GetMsgDesc). The |
| 5611 |
* function returns an enumeration value. To obtain the enum entry's string representation, use @ref GED_GetMessageTypeString. See |
| 5612 |
* @ref GED_PSEUDO_FIELD_MessageTypeDP_DC0Legacy for the field's description. |
| 5613 |
* |
| 5614 |
* @param[in] msgDesc The message descriptor. |
| 5615 |
* @param[in] modelId The GED model by which to interpret. |
| 5616 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific |
| 5617 |
* error which caused the failure. |
| 5618 |
* |
| 5619 |
* @return MessageTypeDP_DC0Legacy's enumeration if the field is valid, GED_MESSAGE_TYPE_INVALID otherwise. |
| 5620 |
*/ |
| 5621 |
extern GED_MESSAGE_TYPE GED_CALLCONV GED_GetMessageTypeDP_DC0Legacy(const uint32_t msgDesc, const GED_MODEL modelId, GED_RETURN_VALUE* |
| 5622 |
result); |
| 5623 |
|
| 5624 |
/*! |
| 5625 |
* Set the value of the MessageTypeDP_DC0Legacy field in the given message descriptor. The latter can then be set to its appropriate |
| 5626 |
* field (@ref GED_SetMsgDesc). See @ref GED_PSEUDO_FIELD_MessageTypeDP_DC0Legacy for the field's description. |
| 5627 |
* |
| 5628 |
* @param[in,out] msgDesc The message descriptor. |
| 5629 |
* @param[in] modelId The GED model by which to interpret. |
| 5630 |
* @param[in] messageType The data port data cache 0 message type. |
| 5631 |
* |
| 5632 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 5633 |
*/ |
| 5634 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetMessageTypeDP_DC0Legacy(uint32_t* msgDesc, const GED_MODEL modelId, const GED_MESSAGE_TYPE |
| 5635 |
messageType); |
| 5636 |
|
| 5637 |
/*! |
| 5638 |
* Get the value of the MessageTypeDP_DC0ScratchBlock field from the given message descriptor (as obtained by @ref GED_GetMsgDesc). |
| 5639 |
* The function returns an enumeration value. To obtain the enum entry's string representation, use @ref GED_GetMessageTypeString. See |
| 5640 |
* @ref GED_PSEUDO_FIELD_MessageTypeDP_DC0ScratchBlock for the field's description. |
| 5641 |
* |
| 5642 |
* @param[in] msgDesc The message descriptor. |
| 5643 |
* @param[in] modelId The GED model by which to interpret. |
| 5644 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific |
| 5645 |
* error which caused the failure. |
| 5646 |
* |
| 5647 |
* @return MessageTypeDP_DC0ScratchBlock's enumeration if the field is valid, GED_MESSAGE_TYPE_INVALID otherwise. |
| 5648 |
*/ |
| 5649 |
extern GED_MESSAGE_TYPE GED_CALLCONV GED_GetMessageTypeDP_DC0ScratchBlock(const uint32_t msgDesc, const GED_MODEL modelId, |
| 5650 |
GED_RETURN_VALUE* result); |
| 5651 |
|
| 5652 |
/*! |
| 5653 |
* Set the value of the MessageTypeDP_DC0ScratchBlock field in the given message descriptor. The latter can then be set to its |
| 5654 |
* appropriate field (@ref GED_SetMsgDesc). See @ref GED_PSEUDO_FIELD_MessageTypeDP_DC0ScratchBlock for the field's description. |
| 5655 |
* |
| 5656 |
* @param[in,out] msgDesc The message descriptor. |
| 5657 |
* @param[in] modelId The GED model by which to interpret. |
| 5658 |
* @param[in] messageType The data port data cache 0 message type. |
| 5659 |
* |
| 5660 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 5661 |
*/ |
| 5662 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetMessageTypeDP_DC0ScratchBlock(uint32_t* msgDesc, const GED_MODEL modelId, const |
| 5663 |
GED_MESSAGE_TYPE messageType); |
| 5664 |
|
| 5665 |
/*! |
| 5666 |
* Get the value of the MessageTypeDP_DC2 field from the given message descriptor (as obtained by @ref GED_GetMsgDesc). The function |
| 5667 |
* returns an enumeration value. To obtain the enum entry's string representation, use @ref GED_GetMessageTypeString. See @ref |
| 5668 |
* GED_PSEUDO_FIELD_MessageTypeDP_DC2 for the field's description. |
| 5669 |
* |
| 5670 |
* @param[in] msgDesc The message descriptor. |
| 5671 |
* @param[in] modelId The GED model by which to interpret. |
| 5672 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific |
| 5673 |
* error which caused the failure. |
| 5674 |
* |
| 5675 |
* @return MessageTypeDP_DC2's enumeration if the field is valid, GED_MESSAGE_TYPE_INVALID otherwise. |
| 5676 |
*/ |
| 5677 |
extern GED_MESSAGE_TYPE GED_CALLCONV GED_GetMessageTypeDP_DC2(const uint32_t msgDesc, const GED_MODEL modelId, GED_RETURN_VALUE* |
| 5678 |
result); |
| 5679 |
|
| 5680 |
/*! |
| 5681 |
* Set the value of the MessageTypeDP_DC2 field in the given message descriptor. The latter can then be set to its appropriate field |
| 5682 |
* (@ref GED_SetMsgDesc). See @ref GED_PSEUDO_FIELD_MessageTypeDP_DC2 for the field's description. |
| 5683 |
* |
| 5684 |
* @param[in,out] msgDesc The message descriptor. |
| 5685 |
* @param[in] modelId The GED model by which to interpret. |
| 5686 |
* @param[in] messageType The data port data cache 2 message type. |
| 5687 |
* |
| 5688 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 5689 |
*/ |
| 5690 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetMessageTypeDP_DC2(uint32_t* msgDesc, const GED_MODEL modelId, const GED_MESSAGE_TYPE |
| 5691 |
messageType); |
| 5692 |
|
| 5693 |
/*! |
| 5694 |
* Get the value of the MessageTypeDP_DCRO field from the given message descriptor (as obtained by @ref GED_GetMsgDesc). The function |
| 5695 |
* returns an enumeration value. To obtain the enum entry's string representation, use @ref GED_GetMessageTypeString. See @ref |
| 5696 |
* GED_PSEUDO_FIELD_MessageTypeDP_DCRO for the field's description. |
| 5697 |
* |
| 5698 |
* @param[in] msgDesc The message descriptor. |
| 5699 |
* @param[in] modelId The GED model by which to interpret. |
| 5700 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific |
| 5701 |
* error which caused the failure. |
| 5702 |
* |
| 5703 |
* @return MessageTypeDP_DCRO's enumeration if the field is valid, GED_MESSAGE_TYPE_INVALID otherwise. |
| 5704 |
*/ |
| 5705 |
extern GED_MESSAGE_TYPE GED_CALLCONV GED_GetMessageTypeDP_DCRO(const uint32_t msgDesc, const GED_MODEL modelId, GED_RETURN_VALUE* |
| 5706 |
result); |
| 5707 |
|
| 5708 |
/*! |
| 5709 |
* Set the value of the MessageTypeDP_DCRO field in the given message descriptor. The latter can then be set to its appropriate field |
| 5710 |
* (@ref GED_SetMsgDesc). See @ref GED_PSEUDO_FIELD_MessageTypeDP_DCRO for the field's description. |
| 5711 |
* |
| 5712 |
* @param[in,out] msgDesc The message descriptor. |
| 5713 |
* @param[in] modelId The GED model by which to interpret. |
| 5714 |
* @param[in] messageType The data port read only message type. |
| 5715 |
* |
| 5716 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 5717 |
*/ |
| 5718 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetMessageTypeDP_DCRO(uint32_t* msgDesc, const GED_MODEL modelId, const GED_MESSAGE_TYPE |
| 5719 |
messageType); |
| 5720 |
|
| 5721 |
/*! |
| 5722 |
* Get the value of the ExMessageLength field from the given extended message descriptor (as obtained by @ref GED_GetExMsgDescImm). |
| 5723 |
* See @ref GED_PSEUDO_FIELD_ExMessageLength for the field's description. |
| 5724 |
* |
| 5725 |
* @param[in] exMsgDesc The extended message descriptor. |
| 5726 |
* @param[in] modelId The GED model by which to interpret. |
| 5727 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific |
| 5728 |
* error which caused the failure. |
| 5729 |
* |
| 5730 |
* @return The exmessage length if the field is valid, the unchanged exMsgDesc value otherwise. |
| 5731 |
*/ |
| 5732 |
extern uint32_t GED_CALLCONV GED_GetExMessageLength(const uint32_t exMsgDesc, const GED_MODEL modelId, GED_RETURN_VALUE* result); |
| 5733 |
|
| 5734 |
/*! |
| 5735 |
* Set the value of the ExMessageLength field in the given extended message descriptor. The latter can then be set to its appropriate |
| 5736 |
* field (@ref GED_SetExMsgDescImm). See @ref GED_PSEUDO_FIELD_ExMessageLength for the field's description. |
| 5737 |
* |
| 5738 |
* @param[in,out] exMsgDesc The extended message descriptor. |
| 5739 |
* @param[in] modelId The GED model by which to interpret. |
| 5740 |
* @param[in] length The exmessage length. |
| 5741 |
* |
| 5742 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 5743 |
*/ |
| 5744 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetExMessageLength(uint32_t* exMsgDesc, const GED_MODEL modelId, const uint32_t length); |
| 5745 |
|
| 5746 |
/*! |
| 5747 |
* Get the value of the DPOpcode field from the given message descriptor (as obtained by @ref GED_GetMsgDesc). The function returns an |
| 5748 |
* enumeration value. To obtain the enum entry's string representation, use @ref GED_GetDpOpcodeString. See @ref |
| 5749 |
* GED_PSEUDO_FIELD_DPOpcode for the field's description. |
| 5750 |
* |
| 5751 |
* @param[in] msgDesc The message descriptor. |
| 5752 |
* @param[in] modelId The GED model by which to interpret. |
| 5753 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific |
| 5754 |
* error which caused the failure. |
| 5755 |
* |
| 5756 |
* @return DPOpcode's enumeration if the field is valid, GED_DP_OPCODE_INVALID otherwise. |
| 5757 |
*/ |
| 5758 |
extern GED_DP_OPCODE GED_CALLCONV GED_GetDPOpcode(const uint32_t msgDesc, const GED_MODEL modelId, GED_RETURN_VALUE* result); |
| 5759 |
|
| 5760 |
/*! |
| 5761 |
* Set the value of the DPOpcode field in the given message descriptor. The latter can then be set to its appropriate field (@ref |
| 5762 |
* GED_SetMsgDesc). See @ref GED_PSEUDO_FIELD_DPOpcode for the field's description. |
| 5763 |
* |
| 5764 |
* @param[in,out] msgDesc The message descriptor. |
| 5765 |
* @param[in] modelId The GED model by which to interpret. |
| 5766 |
* @param[in] opcode The DP operation. |
| 5767 |
* |
| 5768 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 5769 |
*/ |
| 5770 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetDPOpcode(uint32_t* msgDesc, const GED_MODEL modelId, const GED_DP_OPCODE opcode); |
| 5771 |
|
| 5772 |
/*! |
| 5773 |
* Get the value of the DPAddrSurfaceType field from the given message descriptor (as obtained by @ref GED_GetMsgDesc). The function |
| 5774 |
* returns an enumeration value. To obtain the enum entry's string representation, use @ref GED_GetDpAddrSurfaceTypeString. See @ref |
| 5775 |
* GED_PSEUDO_FIELD_DPAddrSurfaceType for the field's description. |
| 5776 |
* |
| 5777 |
* @param[in] msgDesc The message descriptor. |
| 5778 |
* @param[in] modelId The GED model by which to interpret. |
| 5779 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific |
| 5780 |
* error which caused the failure. |
| 5781 |
* |
| 5782 |
* @return DPAddrSurfaceType's enumeration if the field is valid, GED_DP_ADDR_SURFACE_TYPE_INVALID otherwise. |
| 5783 |
*/ |
| 5784 |
extern GED_DP_ADDR_SURFACE_TYPE GED_CALLCONV GED_GetDPAddrSurfaceType(const uint32_t msgDesc, const GED_MODEL modelId, |
| 5785 |
GED_RETURN_VALUE* result); |
| 5786 |
|
| 5787 |
/*! |
| 5788 |
* Set the value of the DPAddrSurfaceType field in the given message descriptor. The latter can then be set to its appropriate field |
| 5789 |
* (@ref GED_SetMsgDesc). See @ref GED_PSEUDO_FIELD_DPAddrSurfaceType for the field's description. |
| 5790 |
* |
| 5791 |
* @param[in,out] msgDesc The message descriptor. |
| 5792 |
* @param[in] modelId The GED model by which to interpret. |
| 5793 |
* @param[in] AddrType The DP addr surface type. |
| 5794 |
* |
| 5795 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 5796 |
*/ |
| 5797 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetDPAddrSurfaceType(uint32_t* msgDesc, const GED_MODEL modelId, const |
| 5798 |
GED_DP_ADDR_SURFACE_TYPE AddrType); |
| 5799 |
|
| 5800 |
/*! |
| 5801 |
* Get the value of the DPVectSize field from the given message descriptor (as obtained by @ref GED_GetMsgDesc). The function returns |
| 5802 |
* an enumeration value. To obtain the enum entry's string representation, use @ref GED_GetDpVectSizeString. See @ref |
| 5803 |
* GED_PSEUDO_FIELD_DPVectSize for the field's description. |
| 5804 |
* |
| 5805 |
* @param[in] msgDesc The message descriptor. |
| 5806 |
* @param[in] modelId The GED model by which to interpret. |
| 5807 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific |
| 5808 |
* error which caused the failure. |
| 5809 |
* |
| 5810 |
* @return DPVectSize's enumeration if the field is valid, GED_DP_VECT_SIZE_INVALID otherwise. |
| 5811 |
*/ |
| 5812 |
extern GED_DP_VECT_SIZE GED_CALLCONV GED_GetDPVectSize(const uint32_t msgDesc, const GED_MODEL modelId, GED_RETURN_VALUE* result); |
| 5813 |
|
| 5814 |
/*! |
| 5815 |
* Set the value of the DPVectSize field in the given message descriptor. The latter can then be set to its appropriate field (@ref |
| 5816 |
* GED_SetMsgDesc). See @ref GED_PSEUDO_FIELD_DPVectSize for the field's description. |
| 5817 |
* |
| 5818 |
* @param[in,out] msgDesc The message descriptor. |
| 5819 |
* @param[in] modelId The GED model by which to interpret. |
| 5820 |
* @param[in] VectSize The DP vector size. |
| 5821 |
* |
| 5822 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 5823 |
*/ |
| 5824 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetDPVectSize(uint32_t* msgDesc, const GED_MODEL modelId, const GED_DP_VECT_SIZE VectSize); |
| 5825 |
|
| 5826 |
/*! |
| 5827 |
* Get the value of the DPFlushType field from the given message descriptor (as obtained by @ref GED_GetMsgDesc). The function returns |
| 5828 |
* an enumeration value. To obtain the enum entry's string representation, use @ref GED_GetDpFlushTypeString. See @ref |
| 5829 |
* GED_PSEUDO_FIELD_DPFlushType for the field's description. |
| 5830 |
* |
| 5831 |
* @param[in] msgDesc The message descriptor. |
| 5832 |
* @param[in] modelId The GED model by which to interpret. |
| 5833 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific |
| 5834 |
* error which caused the failure. |
| 5835 |
* |
| 5836 |
* @return DPFlushType's enumeration if the field is valid, GED_DP_FLUSH_TYPE_INVALID otherwise. |
| 5837 |
*/ |
| 5838 |
extern GED_DP_FLUSH_TYPE GED_CALLCONV GED_GetDPFlushType(const uint32_t msgDesc, const GED_MODEL modelId, GED_RETURN_VALUE* result); |
| 5839 |
|
| 5840 |
/*! |
| 5841 |
* Set the value of the DPFlushType field in the given message descriptor. The latter can then be set to its appropriate field (@ref |
| 5842 |
* GED_SetMsgDesc). See @ref GED_PSEUDO_FIELD_DPFlushType for the field's description. |
| 5843 |
* |
| 5844 |
* @param[in,out] msgDesc The message descriptor. |
| 5845 |
* @param[in] modelId The GED model by which to interpret. |
| 5846 |
* @param[in] FlushType The DP flush type. |
| 5847 |
* |
| 5848 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 5849 |
*/ |
| 5850 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetDPFlushType(uint32_t* msgDesc, const GED_MODEL modelId, const GED_DP_FLUSH_TYPE |
| 5851 |
FlushType); |
| 5852 |
|
| 5853 |
/*! |
| 5854 |
* Get the value of the DPTranspose field from the given message descriptor (as obtained by @ref GED_GetMsgDesc). The function returns |
| 5855 |
* an enumeration value. To obtain the enum entry's string representation, use @ref GED_GetDpTransposeString. See @ref |
| 5856 |
* GED_PSEUDO_FIELD_DPTranspose for the field's description. |
| 5857 |
* |
| 5858 |
* @param[in] msgDesc The message descriptor. |
| 5859 |
* @param[in] modelId The GED model by which to interpret. |
| 5860 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific |
| 5861 |
* error which caused the failure. |
| 5862 |
* |
| 5863 |
* @return DPTranspose's enumeration if the field is valid, GED_DP_TRANSPOSE_INVALID otherwise. |
| 5864 |
*/ |
| 5865 |
extern GED_DP_TRANSPOSE GED_CALLCONV GED_GetDPTranspose(const uint32_t msgDesc, const GED_MODEL modelId, GED_RETURN_VALUE* result); |
| 5866 |
|
| 5867 |
/*! |
| 5868 |
* Set the value of the DPTranspose field in the given message descriptor. The latter can then be set to its appropriate field (@ref |
| 5869 |
* GED_SetMsgDesc). See @ref GED_PSEUDO_FIELD_DPTranspose for the field's description. |
| 5870 |
* |
| 5871 |
* @param[in,out] msgDesc The message descriptor. |
| 5872 |
* @param[in] modelId The GED model by which to interpret. |
| 5873 |
* @param[in] Transpose The DP transpose. |
| 5874 |
* |
| 5875 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 5876 |
*/ |
| 5877 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetDPTranspose(uint32_t* msgDesc, const GED_MODEL modelId, const GED_DP_TRANSPOSE Transpose); |
| 5878 |
|
| 5879 |
/*! |
| 5880 |
* Get the value of the DPFlushRange field from the given message descriptor (as obtained by @ref GED_GetMsgDesc). See @ref |
| 5881 |
* GED_PSEUDO_FIELD_DPFlushRange for the field's description. |
| 5882 |
* |
| 5883 |
* @param[in] msgDesc The message descriptor. |
| 5884 |
* @param[in] modelId The GED model by which to interpret. |
| 5885 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific |
| 5886 |
* error which caused the failure. |
| 5887 |
* |
| 5888 |
* @return The flush range if the field is valid, the unchanged msgDesc value otherwise. |
| 5889 |
*/ |
| 5890 |
extern uint32_t GED_CALLCONV GED_GetDPFlushRange(const uint32_t msgDesc, const GED_MODEL modelId, GED_RETURN_VALUE* result); |
| 5891 |
|
| 5892 |
/*! |
| 5893 |
* Set the value of the DPFlushRange field in the given message descriptor. The latter can then be set to its appropriate field (@ref |
| 5894 |
* GED_SetMsgDesc). See @ref GED_PSEUDO_FIELD_DPFlushRange for the field's description. |
| 5895 |
* |
| 5896 |
* @param[in,out] msgDesc The message descriptor. |
| 5897 |
* @param[in] modelId The GED model by which to interpret. |
| 5898 |
* @param[in] range The flush range. |
| 5899 |
* |
| 5900 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 5901 |
*/ |
| 5902 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetDPFlushRange(uint32_t* msgDesc, const GED_MODEL modelId, const uint32_t range); |
| 5903 |
|
| 5904 |
/*! |
| 5905 |
* Get the value of the DPDataSize field from the given message descriptor (as obtained by @ref GED_GetMsgDesc). The function returns |
| 5906 |
* an enumeration value. To obtain the enum entry's string representation, use @ref GED_GetDpDataSizeString. See @ref |
| 5907 |
* GED_PSEUDO_FIELD_DPDataSize for the field's description. |
| 5908 |
* |
| 5909 |
* @param[in] msgDesc The message descriptor. |
| 5910 |
* @param[in] modelId The GED model by which to interpret. |
| 5911 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific |
| 5912 |
* error which caused the failure. |
| 5913 |
* |
| 5914 |
* @return DPDataSize's enumeration if the field is valid, GED_DP_DATA_SIZE_INVALID otherwise. |
| 5915 |
*/ |
| 5916 |
extern GED_DP_DATA_SIZE GED_CALLCONV GED_GetDPDataSize(const uint32_t msgDesc, const GED_MODEL modelId, GED_RETURN_VALUE* result); |
| 5917 |
|
| 5918 |
/*! |
| 5919 |
* Set the value of the DPDataSize field in the given message descriptor. The latter can then be set to its appropriate field (@ref |
| 5920 |
* GED_SetMsgDesc). See @ref GED_PSEUDO_FIELD_DPDataSize for the field's description. |
| 5921 |
* |
| 5922 |
* @param[in,out] msgDesc The message descriptor. |
| 5923 |
* @param[in] modelId The GED model by which to interpret. |
| 5924 |
* @param[in] DataSize The DP data size. |
| 5925 |
* |
| 5926 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 5927 |
*/ |
| 5928 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetDPDataSize(uint32_t* msgDesc, const GED_MODEL modelId, const GED_DP_DATA_SIZE DataSize); |
| 5929 |
|
| 5930 |
/*! |
| 5931 |
* Get the value of the DPFenceScope field from the given message descriptor (as obtained by @ref GED_GetMsgDesc). The function |
| 5932 |
* returns an enumeration value. To obtain the enum entry's string representation, use @ref GED_GetDpFenceScopeString. See @ref |
| 5933 |
* GED_PSEUDO_FIELD_DPFenceScope for the field's description. |
| 5934 |
* |
| 5935 |
* @param[in] msgDesc The message descriptor. |
| 5936 |
* @param[in] modelId The GED model by which to interpret. |
| 5937 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific |
| 5938 |
* error which caused the failure. |
| 5939 |
* |
| 5940 |
* @return DPFenceScope's enumeration if the field is valid, GED_DP_FENCE_SCOPE_INVALID otherwise. |
| 5941 |
*/ |
| 5942 |
extern GED_DP_FENCE_SCOPE GED_CALLCONV GED_GetDPFenceScope(const uint32_t msgDesc, const GED_MODEL modelId, GED_RETURN_VALUE* result); |
| 5943 |
|
| 5944 |
/*! |
| 5945 |
* Set the value of the DPFenceScope field in the given message descriptor. The latter can then be set to its appropriate field (@ref |
| 5946 |
* GED_SetMsgDesc). See @ref GED_PSEUDO_FIELD_DPFenceScope for the field's description. |
| 5947 |
* |
| 5948 |
* @param[in,out] msgDesc The message descriptor. |
| 5949 |
* @param[in] modelId The GED model by which to interpret. |
| 5950 |
* @param[in] FenceScope The DP fence scope. |
| 5951 |
* |
| 5952 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 5953 |
*/ |
| 5954 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetDPFenceScope(uint32_t* msgDesc, const GED_MODEL modelId, const GED_DP_FENCE_SCOPE |
| 5955 |
FenceScope); |
| 5956 |
|
| 5957 |
/*! |
| 5958 |
* Get the value of the DPAddrSize field from the given message descriptor (as obtained by @ref GED_GetMsgDesc). The function returns |
| 5959 |
* an enumeration value. To obtain the enum entry's string representation, use @ref GED_GetDpAddrSizeString. See @ref |
| 5960 |
* GED_PSEUDO_FIELD_DPAddrSize for the field's description. |
| 5961 |
* |
| 5962 |
* @param[in] msgDesc The message descriptor. |
| 5963 |
* @param[in] modelId The GED model by which to interpret. |
| 5964 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific |
| 5965 |
* error which caused the failure. |
| 5966 |
* |
| 5967 |
* @return DPAddrSize's enumeration if the field is valid, GED_DP_ADDR_SIZE_INVALID otherwise. |
| 5968 |
*/ |
| 5969 |
extern GED_DP_ADDR_SIZE GED_CALLCONV GED_GetDPAddrSize(const uint32_t msgDesc, const GED_MODEL modelId, GED_RETURN_VALUE* result); |
| 5970 |
|
| 5971 |
/*! |
| 5972 |
* Set the value of the DPAddrSize field in the given message descriptor. The latter can then be set to its appropriate field (@ref |
| 5973 |
* GED_SetMsgDesc). See @ref GED_PSEUDO_FIELD_DPAddrSize for the field's description. |
| 5974 |
* |
| 5975 |
* @param[in,out] msgDesc The message descriptor. |
| 5976 |
* @param[in] modelId The GED model by which to interpret. |
| 5977 |
* @param[in] AddrSize The DP address size. |
| 5978 |
* |
| 5979 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 5980 |
*/ |
| 5981 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetDPAddrSize(uint32_t* msgDesc, const GED_MODEL modelId, const GED_DP_ADDR_SIZE AddrSize); |
| 5982 |
|
| 5983 |
/*! |
| 5984 |
* Get the value of the DPCacheStore field from the given (as obtained by @ref GED_GetMsgDesc). The function returns an enumeration |
| 5985 |
* value. To obtain the enum entry's string representation, use @ref GED_GetDPCacheStoreString. See @ref GED_PSEUDO_FIELD_DPCacheStore |
| 5986 |
* for the field's description. |
| 5987 |
* |
| 5988 |
* @param[in] msgDesc The . |
| 5989 |
* @param[in] modelId The GED model by which to interpret. |
| 5990 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific |
| 5991 |
* error which caused the failure. |
| 5992 |
* |
| 5993 |
* @return DPCacheStore's enumeration if the field is valid, GED_DPCACHE_STORE_INVALID otherwise. |
| 5994 |
*/ |
| 5995 |
extern GED_DPCACHE_STORE GED_CALLCONV GED_GetDPCacheStore(const uint32_t msgDesc, const GED_MODEL modelId, GED_RETURN_VALUE* result); |
| 5996 |
|
| 5997 |
/*! |
| 5998 |
* Set the value of the DPCacheStore field in the given . The latter can then be set to its appropriate field (@ref GED_SetMsgDesc). |
| 5999 |
* See @ref GED_PSEUDO_FIELD_DPCacheStore for the field's description. |
| 6000 |
* |
| 6001 |
* @param[in,out] msgDesc The . |
| 6002 |
* @param[in] modelId The GED model by which to interpret. |
| 6003 |
* @param[in] CacheStore The . |
| 6004 |
* |
| 6005 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 6006 |
*/ |
| 6007 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetDPCacheStore(uint32_t* msgDesc, const GED_MODEL modelId, const GED_DPCACHE_STORE |
| 6008 |
CacheStore); |
| 6009 |
|
| 6010 |
/*! |
| 6011 |
* Get the value of the DPCacheLoad field from the given (as obtained by @ref GED_GetMsgDesc). The function returns an enumeration |
| 6012 |
* value. To obtain the enum entry's string representation, use @ref GED_GetDPCacheLoadString. See @ref GED_PSEUDO_FIELD_DPCacheLoad |
| 6013 |
* for the field's description. |
| 6014 |
* |
| 6015 |
* @param[in] msgDesc The . |
| 6016 |
* @param[in] modelId The GED model by which to interpret. |
| 6017 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific |
| 6018 |
* error which caused the failure. |
| 6019 |
* |
| 6020 |
* @return DPCacheLoad's enumeration if the field is valid, GED_DPCACHE_LOAD_INVALID otherwise. |
| 6021 |
*/ |
| 6022 |
extern GED_DPCACHE_LOAD GED_CALLCONV GED_GetDPCacheLoad(const uint32_t msgDesc, const GED_MODEL modelId, GED_RETURN_VALUE* result); |
| 6023 |
|
| 6024 |
/*! |
| 6025 |
* Set the value of the DPCacheLoad field in the given . The latter can then be set to its appropriate field (@ref GED_SetMsgDesc). |
| 6026 |
* See @ref GED_PSEUDO_FIELD_DPCacheLoad for the field's description. |
| 6027 |
* |
| 6028 |
* @param[in,out] msgDesc The . |
| 6029 |
* @param[in] modelId The GED model by which to interpret. |
| 6030 |
* @param[in] CacheLoad The . |
| 6031 |
* |
| 6032 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 6033 |
*/ |
| 6034 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetDPCacheLoad(uint32_t* msgDesc, const GED_MODEL modelId, const GED_DPCACHE_LOAD CacheLoad); |
| 6035 |
|
| 6036 |
/*! |
| 6037 |
* Get the value of the DPAddrRegSize field from the given (as obtained by @ref GED_GetMsgDesc). The function returns an enumeration |
| 6038 |
* value. To obtain the enum entry's string representation, use @ref GED_GetDPAddrRegSizeString. See @ref |
| 6039 |
* GED_PSEUDO_FIELD_DPAddrRegSize for the field's description. |
| 6040 |
* |
| 6041 |
* @param[in] msgDesc The . |
| 6042 |
* @param[in] modelId The GED model by which to interpret. |
| 6043 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific |
| 6044 |
* error which caused the failure. |
| 6045 |
* |
| 6046 |
* @return DPAddrRegSize's enumeration if the field is valid, GED_DPADDR_REG_SIZE_INVALID otherwise. |
| 6047 |
*/ |
| 6048 |
extern GED_DPADDR_REG_SIZE GED_CALLCONV GED_GetDPAddrRegSize(const uint32_t msgDesc, const GED_MODEL modelId, GED_RETURN_VALUE* |
| 6049 |
result); |
| 6050 |
|
| 6051 |
/*! |
| 6052 |
* Set the value of the DPAddrRegSize field in the given . The latter can then be set to its appropriate field (@ref GED_SetMsgDesc). |
| 6053 |
* See @ref GED_PSEUDO_FIELD_DPAddrRegSize for the field's description. |
| 6054 |
* |
| 6055 |
* @param[in,out] msgDesc The . |
| 6056 |
* @param[in] modelId The GED model by which to interpret. |
| 6057 |
* @param[in] AddrRegSize The . |
| 6058 |
* |
| 6059 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 6060 |
*/ |
| 6061 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetDPAddrRegSize(uint32_t* msgDesc, const GED_MODEL modelId, const GED_DPADDR_REG_SIZE |
| 6062 |
AddrRegSize); |
| 6063 |
|
| 6064 |
/*! |
| 6065 |
* Get the value of the DPOneAddrReg field from the given (as obtained by @ref GED_GetMsgDesc). The function returns an enumeration |
| 6066 |
* value. To obtain the enum entry's string representation, use @ref GED_GetDPOneAddrRegString. See @ref GED_PSEUDO_FIELD_DPOneAddrReg |
| 6067 |
* for the field's description. |
| 6068 |
* |
| 6069 |
* @param[in] msgDesc The . |
| 6070 |
* @param[in] modelId The GED model by which to interpret. |
| 6071 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific |
| 6072 |
* error which caused the failure. |
| 6073 |
* |
| 6074 |
* @return DPOneAddrReg's enumeration if the field is valid, GED_DPONE_ADDR_REG_INVALID otherwise. |
| 6075 |
*/ |
| 6076 |
extern GED_DPONE_ADDR_REG GED_CALLCONV GED_GetDPOneAddrReg(const uint32_t msgDesc, const GED_MODEL modelId, GED_RETURN_VALUE* result); |
| 6077 |
|
| 6078 |
/*! |
| 6079 |
* Set the value of the DPOneAddrReg field in the given . The latter can then be set to its appropriate field (@ref GED_SetMsgDesc). |
| 6080 |
* See @ref GED_PSEUDO_FIELD_DPOneAddrReg for the field's description. |
| 6081 |
* |
| 6082 |
* @param[in,out] msgDesc The . |
| 6083 |
* @param[in] modelId The GED model by which to interpret. |
| 6084 |
* @param[in] OneAddrReg The . |
| 6085 |
* |
| 6086 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 6087 |
*/ |
| 6088 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetDPOneAddrReg(uint32_t* msgDesc, const GED_MODEL modelId, const GED_DPONE_ADDR_REG |
| 6089 |
OneAddrReg); |
| 6090 |
|
| 6091 |
/*! |
| 6092 |
* Get the value of the DPCmask field from the given (as obtained by @ref GED_GetMsgDesc). The function returns an enumeration value. |
| 6093 |
* To obtain the enum entry's string representation, use @ref GED_GetDPCmaskString. See @ref GED_PSEUDO_FIELD_DPCmask for the field's |
| 6094 |
* description. |
| 6095 |
* |
| 6096 |
* @param[in] msgDesc The . |
| 6097 |
* @param[in] modelId The GED model by which to interpret. |
| 6098 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific |
| 6099 |
* error which caused the failure. |
| 6100 |
* |
| 6101 |
* @return DPCmask's enumeration if the field is valid, GED_DPCMASK_INVALID otherwise. |
| 6102 |
*/ |
| 6103 |
extern GED_DPCMASK GED_CALLCONV GED_GetDPCmask(const uint32_t msgDesc, const GED_MODEL modelId, GED_RETURN_VALUE* result); |
| 6104 |
|
| 6105 |
/*! |
| 6106 |
* Set the value of the DPCmask field in the given . The latter can then be set to its appropriate field (@ref GED_SetMsgDesc). See |
| 6107 |
* @ref GED_PSEUDO_FIELD_DPCmask for the field's description. |
| 6108 |
* |
| 6109 |
* @param[in,out] msgDesc The . |
| 6110 |
* @param[in] modelId The GED model by which to interpret. |
| 6111 |
* @param[in] Cmask The . |
| 6112 |
* |
| 6113 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 6114 |
*/ |
| 6115 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetDPCmask(uint32_t* msgDesc, const GED_MODEL modelId, const GED_DPCMASK Cmask); |
| 6116 |
|
| 6117 |
/*! |
| 6118 |
* Get the value of the MessageTypeDP_CONST field from the given (as obtained by @ref GED_GetMsgDesc). The function returns an |
| 6119 |
* enumeration value. To obtain the enum entry's string representation, use @ref GED_GetMessageTypeString. See @ref |
| 6120 |
* GED_PSEUDO_FIELD_MessageTypeDP_CONST for the field's description. |
| 6121 |
* |
| 6122 |
* @param[in] msgDesc The . |
| 6123 |
* @param[in] modelId The GED model by which to interpret. |
| 6124 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific |
| 6125 |
* error which caused the failure. |
| 6126 |
* |
| 6127 |
* @return MessageTypeDP_CONST's enumeration if the field is valid, GED_MESSAGE_TYPE_INVALID otherwise. |
| 6128 |
*/ |
| 6129 |
extern GED_MESSAGE_TYPE GED_CALLCONV GED_GetMessageTypeDP_CONST(const uint32_t msgDesc, const GED_MODEL modelId, GED_RETURN_VALUE* |
| 6130 |
result); |
| 6131 |
|
| 6132 |
/*! |
| 6133 |
* Set the value of the MessageTypeDP_CONST field in the given . The latter can then be set to its appropriate field (@ref |
| 6134 |
* GED_SetMsgDesc). See @ref GED_PSEUDO_FIELD_MessageTypeDP_CONST for the field's description. |
| 6135 |
* |
| 6136 |
* @param[in,out] msgDesc The . |
| 6137 |
* @param[in] modelId The GED model by which to interpret. |
| 6138 |
* @param[in] messageType The . |
| 6139 |
* |
| 6140 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 6141 |
*/ |
| 6142 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetMessageTypeDP_CONST(uint32_t* msgDesc, const GED_MODEL modelId, const GED_MESSAGE_TYPE |
| 6143 |
messageType); |
| 6144 |
|
| 6145 |
#if GED_EXPERIMENTAL |
| 6146 |
|
| 6147 |
/*! |
| 6148 |
* Set specific raw bits in native instruction, ignoring value restrictions and encoding masks |
| 6149 |
* |
| 6150 |
* @param[in] ins Pointer to the instruction object containing the field in question. |
| 6151 |
* @param[in] low First bit of the area in the instruction asked to modify. |
| 6152 |
* @param[in] high Last bit of the area in the instruction asked to modify. |
| 6153 |
* @param[in] value The value to encode. |
| 6154 |
* |
| 6155 |
* @return GED_RETURN_VALUE indicating success or encoding error. |
| 6156 |
* |
| 6157 |
* @note Calling this function prevents the application of encoding masks when calling @ref GED_EncodeIns |
| 6158 |
*/ |
| 6159 |
extern GED_RETURN_VALUE GED_CALLCONV GED_SetRawBits(ged_ins_t* ins, uint8_t low, uint8_t high, const uint64_t value); |
| 6160 |
#endif // GED_EXPERIMENTAL |
| 6161 |
|
| 6162 |
/*! |
| 6163 |
* Get the string representation for the given GED_ACCESS_MODE enumerator. The function returns a NULL pointer for |
| 6164 |
* GED_ACCESS_MODE_INVALID. |
| 6165 |
* |
| 6166 |
* @param[in] AccessModeValue The given GED_ACCESS_MODE enumerator. |
| 6167 |
* |
| 6168 |
* @return The requested string. |
| 6169 |
*/ |
| 6170 |
extern const char* GED_CALLCONV GED_GetAccessModeString(GED_ACCESS_MODE AccessModeValue); |
| 6171 |
|
| 6172 |
/*! |
| 6173 |
* Get the string representation for the given GED_ACC_WR_CTRL enumerator. The function returns a NULL pointer for |
| 6174 |
* GED_ACC_WR_CTRL_INVALID. |
| 6175 |
* |
| 6176 |
* @param[in] AccWrCtrlValue The given GED_ACC_WR_CTRL enumerator. |
| 6177 |
* |
| 6178 |
* @return The requested string. |
| 6179 |
*/ |
| 6180 |
extern const char* GED_CALLCONV GED_GetAccWrCtrlString(GED_ACC_WR_CTRL AccWrCtrlValue); |
| 6181 |
|
| 6182 |
/*! |
| 6183 |
* Get the string representation for the given GED_ADDR_MODE enumerator. The function returns a NULL pointer for |
| 6184 |
* GED_ADDR_MODE_INVALID. |
| 6185 |
* |
| 6186 |
* @param[in] AddrModeValue The given GED_ADDR_MODE enumerator. |
| 6187 |
* |
| 6188 |
* @return The requested string. |
| 6189 |
*/ |
| 6190 |
extern const char* GED_CALLCONV GED_GetAddrModeString(GED_ADDR_MODE AddrModeValue); |
| 6191 |
|
| 6192 |
/*! |
| 6193 |
* Get the string representation for the given GED_ARCH_REG enumerator. The function returns a NULL pointer for GED_ARCH_REG_INVALID. |
| 6194 |
* |
| 6195 |
* @param[in] ArchRegValue The given GED_ARCH_REG enumerator. |
| 6196 |
* |
| 6197 |
* @return The requested string. |
| 6198 |
*/ |
| 6199 |
extern const char* GED_CALLCONV GED_GetArchRegString(GED_ARCH_REG ArchRegValue); |
| 6200 |
|
| 6201 |
/*! |
| 6202 |
* Get the string representation for the given GED_ATOMIC_OPERATION_TYPE enumerator. The function returns a NULL pointer for |
| 6203 |
* GED_ATOMIC_OPERATION_TYPE_INVALID. |
| 6204 |
* |
| 6205 |
* @param[in] AtomicOperationTypeValue The given GED_ATOMIC_OPERATION_TYPE enumerator. |
| 6206 |
* |
| 6207 |
* @return The requested string. |
| 6208 |
*/ |
| 6209 |
extern const char* GED_CALLCONV GED_GetAtomicOperationTypeString(GED_ATOMIC_OPERATION_TYPE AtomicOperationTypeValue); |
| 6210 |
|
| 6211 |
/*! |
| 6212 |
* Get the string representation for the given GED_BLOCK_SIZE enumerator. The function returns a NULL pointer for |
| 6213 |
* GED_BLOCK_SIZE_INVALID. |
| 6214 |
* |
| 6215 |
* @param[in] BlockSizeValue The given GED_BLOCK_SIZE enumerator. |
| 6216 |
* |
| 6217 |
* @return The requested string. |
| 6218 |
*/ |
| 6219 |
extern const char* GED_CALLCONV GED_GetBlockSizeString(GED_BLOCK_SIZE BlockSizeValue); |
| 6220 |
|
| 6221 |
/*! |
| 6222 |
* Get the string representation for the given GED_BRANCH_CTRL enumerator. The function returns a NULL pointer for |
| 6223 |
* GED_BRANCH_CTRL_INVALID. |
| 6224 |
* |
| 6225 |
* @param[in] BranchCtrlValue The given GED_BRANCH_CTRL enumerator. |
| 6226 |
* |
| 6227 |
* @return The requested string. |
| 6228 |
*/ |
| 6229 |
extern const char* GED_CALLCONV GED_GetBranchCtrlString(GED_BRANCH_CTRL BranchCtrlValue); |
| 6230 |
|
| 6231 |
/*! |
| 6232 |
* Get the string representation for the given GED_CHANNEL_MASK enumerator. The function returns a NULL pointer for |
| 6233 |
* GED_CHANNEL_MASK_INVALID. |
| 6234 |
* |
| 6235 |
* @param[in] ChannelMaskValue The given GED_CHANNEL_MASK enumerator. |
| 6236 |
* |
| 6237 |
* @return The requested string. |
| 6238 |
*/ |
| 6239 |
extern const char* GED_CALLCONV GED_GetChannelMaskString(GED_CHANNEL_MASK ChannelMaskValue); |
| 6240 |
|
| 6241 |
/*! |
| 6242 |
* Get the string representation for the given GED_CHANNEL_MODE enumerator. The function returns a NULL pointer for |
| 6243 |
* GED_CHANNEL_MODE_INVALID. |
| 6244 |
* |
| 6245 |
* @param[in] ChannelModeValue The given GED_CHANNEL_MODE enumerator. |
| 6246 |
* |
| 6247 |
* @return The requested string. |
| 6248 |
*/ |
| 6249 |
extern const char* GED_CALLCONV GED_GetChannelModeString(GED_CHANNEL_MODE ChannelModeValue); |
| 6250 |
|
| 6251 |
/*! |
| 6252 |
* Get the string representation for the given GED_CHANNEL_OFFSET enumerator. The function returns a NULL pointer for |
| 6253 |
* GED_CHANNEL_OFFSET_INVALID. |
| 6254 |
* |
| 6255 |
* @param[in] ChannelOffsetValue The given GED_CHANNEL_OFFSET enumerator. |
| 6256 |
* |
| 6257 |
* @return The requested string. |
| 6258 |
*/ |
| 6259 |
extern const char* GED_CALLCONV GED_GetChannelOffsetString(GED_CHANNEL_OFFSET ChannelOffsetValue); |
| 6260 |
|
| 6261 |
/*! |
| 6262 |
* Get the string representation for the given GED_COND_MODIFIER enumerator. The function returns a NULL pointer for |
| 6263 |
* GED_COND_MODIFIER_INVALID. |
| 6264 |
* |
| 6265 |
* @param[in] CondModifierValue The given GED_COND_MODIFIER enumerator. |
| 6266 |
* |
| 6267 |
* @return The requested string. |
| 6268 |
*/ |
| 6269 |
extern const char* GED_CALLCONV GED_GetCondModifierString(GED_COND_MODIFIER CondModifierValue); |
| 6270 |
|
| 6271 |
/*! |
| 6272 |
* Get the string representation for the given GED_CONV_DST_DATATYPE enumerator. The function returns a NULL pointer for |
| 6273 |
* GED_CONV_DST_DATATYPE_INVALID. |
| 6274 |
* |
| 6275 |
* @param[in] ConvDstDatatypeValue The given GED_CONV_DST_DATATYPE enumerator. |
| 6276 |
* |
| 6277 |
* @return The requested string. |
| 6278 |
*/ |
| 6279 |
extern const char* GED_CALLCONV GED_GetConvDstDatatypeString(GED_CONV_DST_DATATYPE ConvDstDatatypeValue); |
| 6280 |
|
| 6281 |
/*! |
| 6282 |
* Get the string representation for the given GED_CONV_SRC_DATATYPE enumerator. The function returns a NULL pointer for |
| 6283 |
* GED_CONV_SRC_DATATYPE_INVALID. |
| 6284 |
* |
| 6285 |
* @param[in] ConvSrcDatatypeValue The given GED_CONV_SRC_DATATYPE enumerator. |
| 6286 |
* |
| 6287 |
* @return The requested string. |
| 6288 |
*/ |
| 6289 |
extern const char* GED_CALLCONV GED_GetConvSrcDatatypeString(GED_CONV_SRC_DATATYPE ConvSrcDatatypeValue); |
| 6290 |
|
| 6291 |
/*! |
| 6292 |
* Get the string representation for the given GED_DATA_TYPE enumerator. The function returns a NULL pointer for |
| 6293 |
* GED_DATA_TYPE_INVALID. |
| 6294 |
* |
| 6295 |
* @param[in] DataTypeValue The given GED_DATA_TYPE enumerator. |
| 6296 |
* |
| 6297 |
* @return The requested string. |
| 6298 |
*/ |
| 6299 |
extern const char* GED_CALLCONV GED_GetDataTypeString(GED_DATA_TYPE DataTypeValue); |
| 6300 |
|
| 6301 |
/*! |
| 6302 |
* Get the string representation for the given GED_DEBUG_CTRL enumerator. The function returns a NULL pointer for |
| 6303 |
* GED_DEBUG_CTRL_INVALID. |
| 6304 |
* |
| 6305 |
* @param[in] DebugCtrlValue The given GED_DEBUG_CTRL enumerator. |
| 6306 |
* |
| 6307 |
* @return The requested string. |
| 6308 |
*/ |
| 6309 |
extern const char* GED_CALLCONV GED_GetDebugCtrlString(GED_DEBUG_CTRL DebugCtrlValue); |
| 6310 |
|
| 6311 |
/*! |
| 6312 |
* Get the string representation for the given GED_DEP_CTRL enumerator. The function returns a NULL pointer for GED_DEP_CTRL_INVALID. |
| 6313 |
* |
| 6314 |
* @param[in] DepCtrlValue The given GED_DEP_CTRL enumerator. |
| 6315 |
* |
| 6316 |
* @return The requested string. |
| 6317 |
*/ |
| 6318 |
extern const char* GED_CALLCONV GED_GetDepCtrlString(GED_DEP_CTRL DepCtrlValue); |
| 6319 |
|
| 6320 |
/*! |
| 6321 |
* Get the string representation for the given GED_DNSCL_MODE enumerator. The function returns a NULL pointer for |
| 6322 |
* GED_DNSCL_MODE_INVALID. |
| 6323 |
* |
| 6324 |
* @param[in] DnsclModeValue The given GED_DNSCL_MODE enumerator. |
| 6325 |
* |
| 6326 |
* @return The requested string. |
| 6327 |
*/ |
| 6328 |
extern const char* GED_CALLCONV GED_GetDnsclModeString(GED_DNSCL_MODE DnsclModeValue); |
| 6329 |
|
| 6330 |
/*! |
| 6331 |
* Get the string representation for the given GED_DPADDR_REG_SIZE enumerator. The function returns a NULL pointer for |
| 6332 |
* GED_DPADDR_REG_SIZE_INVALID. |
| 6333 |
* |
| 6334 |
* @param[in] DPAddrRegSizeValue The given GED_DPADDR_REG_SIZE enumerator. |
| 6335 |
* |
| 6336 |
* @return The requested string. |
| 6337 |
*/ |
| 6338 |
extern const char* GED_CALLCONV GED_GetDPAddrRegSizeString(GED_DPADDR_REG_SIZE DPAddrRegSizeValue); |
| 6339 |
|
| 6340 |
/*! |
| 6341 |
* Get the string representation for the given GED_DP_ADDR_SIZE enumerator. The function returns a NULL pointer for |
| 6342 |
* GED_DP_ADDR_SIZE_INVALID. |
| 6343 |
* |
| 6344 |
* @param[in] DpAddrSizeValue The given GED_DP_ADDR_SIZE enumerator. |
| 6345 |
* |
| 6346 |
* @return The requested string. |
| 6347 |
*/ |
| 6348 |
extern const char* GED_CALLCONV GED_GetDpAddrSizeString(GED_DP_ADDR_SIZE DpAddrSizeValue); |
| 6349 |
|
| 6350 |
/*! |
| 6351 |
* Get the string representation for the given GED_DP_ADDR_SURFACE_TYPE enumerator. The function returns a NULL pointer for |
| 6352 |
* GED_DP_ADDR_SURFACE_TYPE_INVALID. |
| 6353 |
* |
| 6354 |
* @param[in] DpAddrSurfaceTypeValue The given GED_DP_ADDR_SURFACE_TYPE enumerator. |
| 6355 |
* |
| 6356 |
* @return The requested string. |
| 6357 |
*/ |
| 6358 |
extern const char* GED_CALLCONV GED_GetDpAddrSurfaceTypeString(GED_DP_ADDR_SURFACE_TYPE DpAddrSurfaceTypeValue); |
| 6359 |
|
| 6360 |
/*! |
| 6361 |
* Get the string representation for the given GED_DPCACHE_LOAD enumerator. The function returns a NULL pointer for |
| 6362 |
* GED_DPCACHE_LOAD_INVALID. |
| 6363 |
* |
| 6364 |
* @param[in] DPCacheLoadValue The given GED_DPCACHE_LOAD enumerator. |
| 6365 |
* |
| 6366 |
* @return The requested string. |
| 6367 |
*/ |
| 6368 |
extern const char* GED_CALLCONV GED_GetDPCacheLoadString(GED_DPCACHE_LOAD DPCacheLoadValue); |
| 6369 |
|
| 6370 |
/*! |
| 6371 |
* Get the string representation for the given GED_DPCACHE_STORE enumerator. The function returns a NULL pointer for |
| 6372 |
* GED_DPCACHE_STORE_INVALID. |
| 6373 |
* |
| 6374 |
* @param[in] DPCacheStoreValue The given GED_DPCACHE_STORE enumerator. |
| 6375 |
* |
| 6376 |
* @return The requested string. |
| 6377 |
*/ |
| 6378 |
extern const char* GED_CALLCONV GED_GetDPCacheStoreString(GED_DPCACHE_STORE DPCacheStoreValue); |
| 6379 |
|
| 6380 |
/*! |
| 6381 |
* Get the string representation for the given GED_DPCMASK enumerator. The function returns a NULL pointer for GED_DPCMASK_INVALID. |
| 6382 |
* |
| 6383 |
* @param[in] DPCmaskValue The given GED_DPCMASK enumerator. |
| 6384 |
* |
| 6385 |
* @return The requested string. |
| 6386 |
*/ |
| 6387 |
extern const char* GED_CALLCONV GED_GetDPCmaskString(GED_DPCMASK DPCmaskValue); |
| 6388 |
|
| 6389 |
/*! |
| 6390 |
* Get the string representation for the given GED_DP_DATA_SIZE enumerator. The function returns a NULL pointer for |
| 6391 |
* GED_DP_DATA_SIZE_INVALID. |
| 6392 |
* |
| 6393 |
* @param[in] DpDataSizeValue The given GED_DP_DATA_SIZE enumerator. |
| 6394 |
* |
| 6395 |
* @return The requested string. |
| 6396 |
*/ |
| 6397 |
extern const char* GED_CALLCONV GED_GetDpDataSizeString(GED_DP_DATA_SIZE DpDataSizeValue); |
| 6398 |
|
| 6399 |
/*! |
| 6400 |
* Get the string representation for the given GED_DP_FENCE_SCOPE enumerator. The function returns a NULL pointer for |
| 6401 |
* GED_DP_FENCE_SCOPE_INVALID. |
| 6402 |
* |
| 6403 |
* @param[in] DpFenceScopeValue The given GED_DP_FENCE_SCOPE enumerator. |
| 6404 |
* |
| 6405 |
* @return The requested string. |
| 6406 |
*/ |
| 6407 |
extern const char* GED_CALLCONV GED_GetDpFenceScopeString(GED_DP_FENCE_SCOPE DpFenceScopeValue); |
| 6408 |
|
| 6409 |
/*! |
| 6410 |
* Get the string representation for the given GED_DP_FLUSH_TYPE enumerator. The function returns a NULL pointer for |
| 6411 |
* GED_DP_FLUSH_TYPE_INVALID. |
| 6412 |
* |
| 6413 |
* @param[in] DpFlushTypeValue The given GED_DP_FLUSH_TYPE enumerator. |
| 6414 |
* |
| 6415 |
* @return The requested string. |
| 6416 |
*/ |
| 6417 |
extern const char* GED_CALLCONV GED_GetDpFlushTypeString(GED_DP_FLUSH_TYPE DpFlushTypeValue); |
| 6418 |
|
| 6419 |
/*! |
| 6420 |
* Get the string representation for the given GED_DPONE_ADDR_REG enumerator. The function returns a NULL pointer for |
| 6421 |
* GED_DPONE_ADDR_REG_INVALID. |
| 6422 |
* |
| 6423 |
* @param[in] DPOneAddrRegValue The given GED_DPONE_ADDR_REG enumerator. |
| 6424 |
* |
| 6425 |
* @return The requested string. |
| 6426 |
*/ |
| 6427 |
extern const char* GED_CALLCONV GED_GetDPOneAddrRegString(GED_DPONE_ADDR_REG DPOneAddrRegValue); |
| 6428 |
|
| 6429 |
/*! |
| 6430 |
* Get the string representation for the given GED_DP_OPCODE enumerator. The function returns a NULL pointer for |
| 6431 |
* GED_DP_OPCODE_INVALID. |
| 6432 |
* |
| 6433 |
* @param[in] DpOpcodeValue The given GED_DP_OPCODE enumerator. |
| 6434 |
* |
| 6435 |
* @return The requested string. |
| 6436 |
*/ |
| 6437 |
extern const char* GED_CALLCONV GED_GetDpOpcodeString(GED_DP_OPCODE DpOpcodeValue); |
| 6438 |
|
| 6439 |
/*! |
| 6440 |
* Get the string representation for the given GED_DP_TRANSPOSE enumerator. The function returns a NULL pointer for |
| 6441 |
* GED_DP_TRANSPOSE_INVALID. |
| 6442 |
* |
| 6443 |
* @param[in] DpTransposeValue The given GED_DP_TRANSPOSE enumerator. |
| 6444 |
* |
| 6445 |
* @return The requested string. |
| 6446 |
*/ |
| 6447 |
extern const char* GED_CALLCONV GED_GetDpTransposeString(GED_DP_TRANSPOSE DpTransposeValue); |
| 6448 |
|
| 6449 |
/*! |
| 6450 |
* Get the string representation for the given GED_DP_VECT_SIZE enumerator. The function returns a NULL pointer for |
| 6451 |
* GED_DP_VECT_SIZE_INVALID. |
| 6452 |
* |
| 6453 |
* @param[in] DpVectSizeValue The given GED_DP_VECT_SIZE enumerator. |
| 6454 |
* |
| 6455 |
* @return The requested string. |
| 6456 |
*/ |
| 6457 |
extern const char* GED_CALLCONV GED_GetDpVectSizeString(GED_DP_VECT_SIZE DpVectSizeValue); |
| 6458 |
|
| 6459 |
/*! |
| 6460 |
* Get the string representation for the given GED_DST_CHAN_EN enumerator. The function returns a NULL pointer for |
| 6461 |
* GED_DST_CHAN_EN_INVALID. |
| 6462 |
* |
| 6463 |
* @param[in] DstChanEnValue The given GED_DST_CHAN_EN enumerator. |
| 6464 |
* |
| 6465 |
* @return The requested string. |
| 6466 |
*/ |
| 6467 |
extern const char* GED_CALLCONV GED_GetDstChanEnString(GED_DST_CHAN_EN DstChanEnValue); |
| 6468 |
|
| 6469 |
/*! |
| 6470 |
* Get the string representation for the given GED_EOT enumerator. The function returns a NULL pointer for GED_EOT_INVALID. |
| 6471 |
* |
| 6472 |
* @param[in] EOTValue The given GED_EOT enumerator. |
| 6473 |
* |
| 6474 |
* @return The requested string. |
| 6475 |
*/ |
| 6476 |
extern const char* GED_CALLCONV GED_GetEOTString(GED_EOT EOTValue); |
| 6477 |
|
| 6478 |
/*! |
| 6479 |
* Get the string representation for the given GED_EXEC_MASK_OFFSET_CTRL enumerator. The function returns a NULL pointer for |
| 6480 |
* GED_EXEC_MASK_OFFSET_CTRL_INVALID. |
| 6481 |
* |
| 6482 |
* @param[in] ExecMaskOffsetCtrlValue The given GED_EXEC_MASK_OFFSET_CTRL enumerator. |
| 6483 |
* |
| 6484 |
* @return The requested string. |
| 6485 |
*/ |
| 6486 |
extern const char* GED_CALLCONV GED_GetExecMaskOffsetCtrlString(GED_EXEC_MASK_OFFSET_CTRL ExecMaskOffsetCtrlValue); |
| 6487 |
|
| 6488 |
/*! |
| 6489 |
* Get the string representation for the given GED_EXECUTION_DATA_TYPE enumerator. The function returns a NULL pointer for |
| 6490 |
* GED_EXECUTION_DATA_TYPE_INVALID. |
| 6491 |
* |
| 6492 |
* @param[in] ExecutionDataTypeValue The given GED_EXECUTION_DATA_TYPE enumerator. |
| 6493 |
* |
| 6494 |
* @return The requested string. |
| 6495 |
*/ |
| 6496 |
extern const char* GED_CALLCONV GED_GetExecutionDataTypeString(GED_EXECUTION_DATA_TYPE ExecutionDataTypeValue); |
| 6497 |
|
| 6498 |
/*! |
| 6499 |
* Get the string representation for the given GED_FUSION_CTRL enumerator. The function returns a NULL pointer for |
| 6500 |
* GED_FUSION_CTRL_INVALID. |
| 6501 |
* |
| 6502 |
* @param[in] FusionCtrlValue The given GED_FUSION_CTRL enumerator. |
| 6503 |
* |
| 6504 |
* @return The requested string. |
| 6505 |
*/ |
| 6506 |
extern const char* GED_CALLCONV GED_GetFusionCtrlString(GED_FUSION_CTRL FusionCtrlValue); |
| 6507 |
|
| 6508 |
/*! |
| 6509 |
* Get the string representation for the given GED_HEADER_PRESENT enumerator. The function returns a NULL pointer for |
| 6510 |
* GED_HEADER_PRESENT_INVALID. |
| 6511 |
* |
| 6512 |
* @param[in] HeaderPresentValue The given GED_HEADER_PRESENT enumerator. |
| 6513 |
* |
| 6514 |
* @return The requested string. |
| 6515 |
*/ |
| 6516 |
extern const char* GED_CALLCONV GED_GetHeaderPresentString(GED_HEADER_PRESENT HeaderPresentValue); |
| 6517 |
|
| 6518 |
/*! |
| 6519 |
* Get the string representation for the given GED_IS_IMM enumerator. The function returns a NULL pointer for GED_IS_IMM_INVALID. |
| 6520 |
* |
| 6521 |
* @param[in] IsImmValue The given GED_IS_IMM enumerator. |
| 6522 |
* |
| 6523 |
* @return The requested string. |
| 6524 |
*/ |
| 6525 |
extern const char* GED_CALLCONV GED_GetIsImmString(GED_IS_IMM IsImmValue); |
| 6526 |
|
| 6527 |
/*! |
| 6528 |
* Get the string representation for the given GED_LFSR_FC enumerator. The function returns a NULL pointer for GED_LFSR_FC_INVALID. |
| 6529 |
* |
| 6530 |
* @param[in] LfsrFCValue The given GED_LFSR_FC enumerator. |
| 6531 |
* |
| 6532 |
* @return The requested string. |
| 6533 |
*/ |
| 6534 |
extern const char* GED_CALLCONV GED_GetLfsrFCString(GED_LFSR_FC LfsrFCValue); |
| 6535 |
|
| 6536 |
/*! |
| 6537 |
* Get the string representation for the given GED_MASK_CTRL enumerator. The function returns a NULL pointer for |
| 6538 |
* GED_MASK_CTRL_INVALID. |
| 6539 |
* |
| 6540 |
* @param[in] MaskCtrlValue The given GED_MASK_CTRL enumerator. |
| 6541 |
* |
| 6542 |
* @return The requested string. |
| 6543 |
*/ |
| 6544 |
extern const char* GED_CALLCONV GED_GetMaskCtrlString(GED_MASK_CTRL MaskCtrlValue); |
| 6545 |
|
| 6546 |
/*! |
| 6547 |
* Get the string representation for the given GED_MATH_FC enumerator. The function returns a NULL pointer for GED_MATH_FC_INVALID. |
| 6548 |
* |
| 6549 |
* @param[in] MathFCValue The given GED_MATH_FC enumerator. |
| 6550 |
* |
| 6551 |
* @return The requested string. |
| 6552 |
*/ |
| 6553 |
extern const char* GED_CALLCONV GED_GetMathFCString(GED_MATH_FC MathFCValue); |
| 6554 |
|
| 6555 |
/*! |
| 6556 |
* Get the string representation for the given GED_MATH_MACRO_EXT enumerator. The function returns a NULL pointer for |
| 6557 |
* GED_MATH_MACRO_EXT_INVALID. |
| 6558 |
* |
| 6559 |
* @param[in] MathMacroExtValue The given GED_MATH_MACRO_EXT enumerator. |
| 6560 |
* |
| 6561 |
* @return The requested string. |
| 6562 |
*/ |
| 6563 |
extern const char* GED_CALLCONV GED_GetMathMacroExtString(GED_MATH_MACRO_EXT MathMacroExtValue); |
| 6564 |
|
| 6565 |
/*! |
| 6566 |
* Get the string representation for the given GED_MESSAGE_TYPE enumerator. The function returns a NULL pointer for |
| 6567 |
* GED_MESSAGE_TYPE_INVALID. |
| 6568 |
* |
| 6569 |
* @param[in] MessageTypeValue The given GED_MESSAGE_TYPE enumerator. |
| 6570 |
* |
| 6571 |
* @return The requested string. |
| 6572 |
*/ |
| 6573 |
extern const char* GED_CALLCONV GED_GetMessageTypeString(GED_MESSAGE_TYPE MessageTypeValue); |
| 6574 |
|
| 6575 |
/*! |
| 6576 |
* Get the string representation for the given GED_NO_SRC_DEP_SET enumerator. The function returns a NULL pointer for |
| 6577 |
* GED_NO_SRC_DEP_SET_INVALID. |
| 6578 |
* |
| 6579 |
* @param[in] NoSrcDepSetValue The given GED_NO_SRC_DEP_SET enumerator. |
| 6580 |
* |
| 6581 |
* @return The requested string. |
| 6582 |
*/ |
| 6583 |
extern const char* GED_CALLCONV GED_GetNoSrcDepSetString(GED_NO_SRC_DEP_SET NoSrcDepSetValue); |
| 6584 |
|
| 6585 |
/*! |
| 6586 |
* Get the string representation for the given GED_OPCODE enumerator. The function returns a NULL pointer for GED_OPCODE_INVALID. |
| 6587 |
* |
| 6588 |
* @param[in] OpcodeValue The given GED_OPCODE enumerator. |
| 6589 |
* |
| 6590 |
* @return The requested string. |
| 6591 |
*/ |
| 6592 |
extern const char* GED_CALLCONV GED_GetOpcodeString(GED_OPCODE OpcodeValue); |
| 6593 |
|
| 6594 |
/*! |
| 6595 |
* Get the string representation for the given GED_PRECISION enumerator. The function returns a NULL pointer for |
| 6596 |
* GED_PRECISION_INVALID. |
| 6597 |
* |
| 6598 |
* @param[in] PrecisionValue The given GED_PRECISION enumerator. |
| 6599 |
* |
| 6600 |
* @return The requested string. |
| 6601 |
*/ |
| 6602 |
extern const char* GED_CALLCONV GED_GetPrecisionString(GED_PRECISION PrecisionValue); |
| 6603 |
|
| 6604 |
/*! |
| 6605 |
* Get the string representation for the given GED_PRED_CTRL enumerator. The function returns a NULL pointer for |
| 6606 |
* GED_PRED_CTRL_INVALID. |
| 6607 |
* |
| 6608 |
* @param[in] PredCtrlValue The given GED_PRED_CTRL enumerator. |
| 6609 |
* |
| 6610 |
* @return The requested string. |
| 6611 |
*/ |
| 6612 |
extern const char* GED_CALLCONV GED_GetPredCtrlString(GED_PRED_CTRL PredCtrlValue); |
| 6613 |
|
| 6614 |
/*! |
| 6615 |
* Get the string representation for the given GED_PRED_INV enumerator. The function returns a NULL pointer for GED_PRED_INV_INVALID. |
| 6616 |
* |
| 6617 |
* @param[in] PredInvValue The given GED_PRED_INV enumerator. |
| 6618 |
* |
| 6619 |
* @return The requested string. |
| 6620 |
*/ |
| 6621 |
extern const char* GED_CALLCONV GED_GetPredInvString(GED_PRED_INV PredInvValue); |
| 6622 |
|
| 6623 |
/*! |
| 6624 |
* Get the string representation for the given GED_REG_FILE enumerator. The function returns a NULL pointer for GED_REG_FILE_INVALID. |
| 6625 |
* |
| 6626 |
* @param[in] RegFileValue The given GED_REG_FILE enumerator. |
| 6627 |
* |
| 6628 |
* @return The requested string. |
| 6629 |
*/ |
| 6630 |
extern const char* GED_CALLCONV GED_GetRegFileString(GED_REG_FILE RegFileValue); |
| 6631 |
|
| 6632 |
/*! |
| 6633 |
* Get the string representation for the given GED_REP_CTRL enumerator. The function returns a NULL pointer for GED_REP_CTRL_INVALID. |
| 6634 |
* |
| 6635 |
* @param[in] RepCtrlValue The given GED_REP_CTRL enumerator. |
| 6636 |
* |
| 6637 |
* @return The requested string. |
| 6638 |
*/ |
| 6639 |
extern const char* GED_CALLCONV GED_GetRepCtrlString(GED_REP_CTRL RepCtrlValue); |
| 6640 |
|
| 6641 |
/*! |
| 6642 |
* Get the string representation for the given GED_RETURN_DATA_CONTROL enumerator. The function returns a NULL pointer for |
| 6643 |
* GED_RETURN_DATA_CONTROL_INVALID. |
| 6644 |
* |
| 6645 |
* @param[in] ReturnDataControlValue The given GED_RETURN_DATA_CONTROL enumerator. |
| 6646 |
* |
| 6647 |
* @return The requested string. |
| 6648 |
*/ |
| 6649 |
extern const char* GED_CALLCONV GED_GetReturnDataControlString(GED_RETURN_DATA_CONTROL ReturnDataControlValue); |
| 6650 |
|
| 6651 |
/*! |
| 6652 |
* Get the string representation for the given GED_ROUNDING_MODE enumerator. The function returns a NULL pointer for |
| 6653 |
* GED_ROUNDING_MODE_INVALID. |
| 6654 |
* |
| 6655 |
* @param[in] RoundingModeValue The given GED_ROUNDING_MODE enumerator. |
| 6656 |
* |
| 6657 |
* @return The requested string. |
| 6658 |
*/ |
| 6659 |
extern const char* GED_CALLCONV GED_GetRoundingModeString(GED_ROUNDING_MODE RoundingModeValue); |
| 6660 |
|
| 6661 |
/*! |
| 6662 |
* Get the string representation for the given GED_SATURATE enumerator. The function returns a NULL pointer for GED_SATURATE_INVALID. |
| 6663 |
* |
| 6664 |
* @param[in] SaturateValue The given GED_SATURATE enumerator. |
| 6665 |
* |
| 6666 |
* @return The requested string. |
| 6667 |
*/ |
| 6668 |
extern const char* GED_CALLCONV GED_GetSaturateString(GED_SATURATE SaturateValue); |
| 6669 |
|
| 6670 |
/*! |
| 6671 |
* Get the string representation for the given GED_SFID enumerator. The function returns a NULL pointer for GED_SFID_INVALID. |
| 6672 |
* |
| 6673 |
* @param[in] SFIDValue The given GED_SFID enumerator. |
| 6674 |
* |
| 6675 |
* @return The requested string. |
| 6676 |
*/ |
| 6677 |
extern const char* GED_CALLCONV GED_GetSFIDString(GED_SFID SFIDValue); |
| 6678 |
|
| 6679 |
/*! |
| 6680 |
* Get the string representation for the given GED_SHUFFLE_FC enumerator. The function returns a NULL pointer for |
| 6681 |
* GED_SHUFFLE_FC_INVALID. |
| 6682 |
* |
| 6683 |
* @param[in] ShuffleFCValue The given GED_SHUFFLE_FC enumerator. |
| 6684 |
* |
| 6685 |
* @return The requested string. |
| 6686 |
*/ |
| 6687 |
extern const char* GED_CALLCONV GED_GetShuffleFCString(GED_SHUFFLE_FC ShuffleFCValue); |
| 6688 |
|
| 6689 |
/*! |
| 6690 |
* Get the string representation for the given GED_SIMDMODE enumerator. The function returns a NULL pointer for GED_SIMDMODE_INVALID. |
| 6691 |
* |
| 6692 |
* @param[in] SIMDModeValue The given GED_SIMDMODE enumerator. |
| 6693 |
* |
| 6694 |
* @return The requested string. |
| 6695 |
*/ |
| 6696 |
extern const char* GED_CALLCONV GED_GetSIMDModeString(GED_SIMDMODE SIMDModeValue); |
| 6697 |
|
| 6698 |
/*! |
| 6699 |
* Get the string representation for the given GED_SLOT_GROUP enumerator. The function returns a NULL pointer for |
| 6700 |
* GED_SLOT_GROUP_INVALID. |
| 6701 |
* |
| 6702 |
* @param[in] SlotGroupValue The given GED_SLOT_GROUP enumerator. |
| 6703 |
* |
| 6704 |
* @return The requested string. |
| 6705 |
*/ |
| 6706 |
extern const char* GED_CALLCONV GED_GetSlotGroupString(GED_SLOT_GROUP SlotGroupValue); |
| 6707 |
|
| 6708 |
/*! |
| 6709 |
* Get the string representation for the given GED_SRC_MOD enumerator. The function returns a NULL pointer for GED_SRC_MOD_INVALID. |
| 6710 |
* |
| 6711 |
* @param[in] SrcModValue The given GED_SRC_MOD enumerator. |
| 6712 |
* |
| 6713 |
* @return The requested string. |
| 6714 |
*/ |
| 6715 |
extern const char* GED_CALLCONV GED_GetSrcModString(GED_SRC_MOD SrcModValue); |
| 6716 |
|
| 6717 |
/*! |
| 6718 |
* Get the string representation for the given GED_SUB_BYTE_PRECISION enumerator. The function returns a NULL pointer for |
| 6719 |
* GED_SUB_BYTE_PRECISION_INVALID. |
| 6720 |
* |
| 6721 |
* @param[in] SubBytePrecisionValue The given GED_SUB_BYTE_PRECISION enumerator. |
| 6722 |
* |
| 6723 |
* @return The requested string. |
| 6724 |
*/ |
| 6725 |
extern const char* GED_CALLCONV GED_GetSubBytePrecisionString(GED_SUB_BYTE_PRECISION SubBytePrecisionValue); |
| 6726 |
|
| 6727 |
/*! |
| 6728 |
* Get the string representation for the given GED_SUB_FUNC_ID enumerator. The function returns a NULL pointer for |
| 6729 |
* GED_SUB_FUNC_ID_INVALID. |
| 6730 |
* |
| 6731 |
* @param[in] SubFuncIDValue The given GED_SUB_FUNC_ID enumerator. |
| 6732 |
* |
| 6733 |
* @return The requested string. |
| 6734 |
*/ |
| 6735 |
extern const char* GED_CALLCONV GED_GetSubFuncIDString(GED_SUB_FUNC_ID SubFuncIDValue); |
| 6736 |
|
| 6737 |
/*! |
| 6738 |
* Get the string representation for the given GED_SWIZZLE enumerator. The function returns a NULL pointer for GED_SWIZZLE_INVALID. |
| 6739 |
* |
| 6740 |
* @param[in] SwizzleValue The given GED_SWIZZLE enumerator. |
| 6741 |
* |
| 6742 |
* @return The requested string. |
| 6743 |
*/ |
| 6744 |
extern const char* GED_CALLCONV GED_GetSwizzleString(GED_SWIZZLE SwizzleValue); |
| 6745 |
|
| 6746 |
/*! |
| 6747 |
* Get the string representation for the given GED_SYNC_FC enumerator. The function returns a NULL pointer for GED_SYNC_FC_INVALID. |
| 6748 |
* |
| 6749 |
* @param[in] SyncFCValue The given GED_SYNC_FC enumerator. |
| 6750 |
* |
| 6751 |
* @return The requested string. |
| 6752 |
*/ |
| 6753 |
extern const char* GED_CALLCONV GED_GetSyncFCString(GED_SYNC_FC SyncFCValue); |
| 6754 |
|
| 6755 |
/*! |
| 6756 |
* Get the string representation for the given GED_THREAD_CTRL enumerator. The function returns a NULL pointer for |
| 6757 |
* GED_THREAD_CTRL_INVALID. |
| 6758 |
* |
| 6759 |
* @param[in] ThreadCtrlValue The given GED_THREAD_CTRL enumerator. |
| 6760 |
* |
| 6761 |
* @return The requested string. |
| 6762 |
*/ |
| 6763 |
extern const char* GED_CALLCONV GED_GetThreadCtrlString(GED_THREAD_CTRL ThreadCtrlValue); |
| 6764 |
|
| 6765 |
/*! |
| 6766 |
* Determine whether the given vertical stride represents Vx1 or VxH. |
| 6767 |
* |
| 6768 |
* @param[in] vertstride The vertical stride to check. |
| 6769 |
* |
| 6770 |
* @return TRUE if the given vertical stride represents Vx1 or VxH, FALSE otherwise. |
| 6771 |
*/ |
| 6772 |
GED_INLINE bool GED_CALLCONV GED_IsVx1VxH(uint32_t vertstride) |
| 6773 |
{ |
| 6774 |
return (3 == vertstride); |
| 6775 |
} |
| 6776 |
|
| 6777 |
/*! |
| 6778 |
* The operand width, based on its data type. |
| 6779 |
* |
| 6780 |
* @param[in] datatype The @ref GED_DATA_TYPE enumerator to interpret. |
| 6781 |
* @param[in] modelId The GED model by which to interpret. |
| 6782 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific |
| 6783 |
* error which caused the failure. |
| 6784 |
* |
| 6785 |
* @return The requested value. |
| 6786 |
*/ |
| 6787 |
extern uint32_t GED_CALLCONV GED_GetOperandWidth(const GED_DATA_TYPE datatype, const GED_MODEL modelId, GED_RETURN_VALUE* result); |
| 6788 |
|
| 6789 |
/*! |
| 6790 |
* The numeric type in which to display an operand, based on its data type. Relevant only for immediate operands. |
| 6791 |
* |
| 6792 |
* @param[in] datatype The @ref GED_DATA_TYPE enumerator to interpret. |
| 6793 |
* @param[in] modelId The GED model by which to interpret. |
| 6794 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the specific |
| 6795 |
* error which caused the failure. |
| 6796 |
* |
| 6797 |
* @return The requested value. |
| 6798 |
*/ |
| 6799 |
extern uint32_t GED_CALLCONV GED_GetOperandNumericType(const GED_DATA_TYPE datatype, const GED_MODEL modelId, GED_RETURN_VALUE* |
| 6800 |
result); |
| 6801 |
|
| 6802 |
/*! |
| 6803 |
* |
| 6804 |
* Nibble Control. This field is used in some instructions along with QtrCtrl. See the description of |
| 6805 |
* ExecMaskOffsetCtrl. |
| 6806 |
* NibCtrl is only used for SIMD4 instructions. |
| 6807 |
* |
| 6808 |
* |
| 6809 |
* @param[in] execmaskoffsetctrl The @ref GED_EXEC_MASK_OFFSET_CTRL enumerator to interpret. |
| 6810 |
* @param[in] modelId The GED model by which to interpret. |
| 6811 |
* @param[out] result If non-null, the function stores the @ref GED_RETURN_VALUE result indicating success or the |
| 6812 |
* specific error which caused the failure. |
| 6813 |
* |
| 6814 |
* @return The requested value. |
| 6815 |
*/ |
| 6816 |
extern uint32_t GED_CALLCONV GED_GetNibCtrl(const GED_EXEC_MASK_OFFSET_CTRL execmaskoffsetctrl, const GED_MODEL modelId, |
| 6817 |
GED_RETURN_VALUE* result); |
| 6818 |
|
| 6819 |
#ifdef __cplusplus |
| 6820 |
}// extern "C" |
| 6821 |
#endif // __cplusplus |
| 6822 |
#endif // GED_H |