rdi_prop.h

8990的核心级资料

 *
 *      Input:  unsigned groupId
 *                     If groupId == RDIPropertyGroup_SuperGroup:
 *                       This is a request for description of ALL
 *                       the properties in all groups for this module.
 *
 *                     If groupId == RDIPropertyGroup_TopLevelGroup:
 *                        This will return no data, since the top level group
 *                        may only contain groups.
 *
 *                     If groupId == something else:
 *                        Any other value must be a valid group id as returned
 *                        in one of the group descriptions returned by
 *                        RDIProperty_RequestGroups
 *
 *     In/Out:  arg2   RDIProperty_Desc *array.
 *                     An array of sufficient size for the number of properties
 *                     in this group.  The array will be filled in by this
 *                     function with the property descriptions.
 *
 *  Returns:
 *      OK:     RDIError_NoError
 *      Error:  RDIError_UnimplementedMessage - not understood
 *      Error:  RDIError_NoSuchHandle         - bad group id passed in
 */
#define RDIProperty_RequestDescriptions 0x702


/*
 * Function: RDI_InfoProc(mh, RDIProperty_GetAsNumeric, arg1, arg2)
 * 
 *  Version: RDI 1.51
 *
 *  Purpose: Get the numeric value of the specified property.
 *
 *           This is only supported for a particular module/agent handle
 *           and property id, if that property had indicated it supports
 *           'asNumeric' access.
 *
 *   Params:
 *       Input: mh      handle identifies agent/processor
 *
 *              type    RDIProperty_GetAsNumeric
 *
 *              arg1    unsigned32 id
 *                      Property id as returned in the RDIProperty_Desc struct.
 *
 *      In/Out: arg2    void *buf
 *                      The caller passes in a buffer of sufficient size for
 *                      all allowed values of the property to be written into
 *                      the buffer.
 *                      The size of the buffer required is all specified
 *                      by the width field in the RDIProperty_Desc struct.
 *   
 *   Returns:   RDIError_NoError - no error
 *              RDIError_NoSuchHandle - the property was specified incorrectly
 *                       (ie. the one specified does not exist).
 *              RDIError_Unset - the property should currently be greyed out.
 *                       However, a value is still returned in case greying out
 *                       is not supported.
 */
#define RDIProperty_GetAsNumeric 0x703


/*
 * Function: RDI_InfoProc(mh, RDIProperty_GetAsString, arg1, arg2)
 * 
 *  Version: RDI 1.51
 *
 *  Purpose: Get the string value of the specified property
 *
 *           This is only supported for a particular module/agent handle
 *           and property id, if that property had indicated it supports
 *           'asString' access.
 *
 *   Params:
 *       Input: mh      handle identifies agent/processor
 *
 *              type    RDIProperty_GetAsString
 *
 *              arg1    unsigned32 id
 *                      Property id as returned in the RDIProperty_Desc struct.
 *
 *      In/Out: arg2    void *buf
 *                      The caller passes in a buffer of sufficient size for
 *                      all allowed values of the property to be written into
 *                      the buffer.
 *                      The size of the buffer required is all specified
 *                      by the maxLen field in the RDIProperty_Desc struct.
 *   
 *   Returns:   RDIError_NoError - no error
 *              RDIError_NoSuchHandle - the property was specified incorrectly
 *                       (ie. the one specified does not exist).
 *              RDIError_Unset - the property should currently be greyed out.
 *                       However, a value is still returned in case greying out
 *                       is not supported.
 */
#define RDIProperty_GetAsString 0x704


/*
 * Function: RDI_InfoProc(mh, RDIProperty_SetAsNumeric, arg1, arg2)
 * 
 *  Version: RDI 1.51
 *
 *  Purpose: Set the numeric value of the specified property.
 *
 *           This is only supported for a particular module/agent handle
 *           and property id, if that property had indicated it supports
 *           'asNumeric' access.
 *
 *           Note that all properties in the same group are considered
 *           related, so that if any property in a group is changed then all
 *           others in that group should be reread.  This allows several
 *           properties in a group to be dependent on each other.
 *
 *           If the debug controller is offering a flat display of properties,
 *           using the RDIPropertyGroup_SuperGroup group, then it should
 *           re-read all properties whenever a single property gets set.
 *
 *   Params:
 *       Input: mh      handle identifies debug agent / processor / thread
 *
 *              type    RDIProperty_SetAsNumeric
 *
 *              arg1    unsigned32 id
 *                      Property id as returned in the RDIProperty_Desc struct.
 *
 *      In/Out: arg2    void *buf
 *                      The caller passes in a buffer containing the new value
 *                      for the specified property.
 *   
 *   Returns:
 *         OK:  RDIError_NoError - no error
 *       Error: RDIError_NoSuchHandle - the property was specified incorrectly
 *                                      (ie. the one specified does not exist).
 *       Error: RDIError_ReadOnly - this variable is readonly - request ignored
 *       Error: RDIError_BadValue - value specified was illegal for this
 *                                  variable request ignored.
 */
#define RDIProperty_SetAsNumeric 0x705


/*
 * Function: RDI_InfoProc(mh, RDIProperty_SetAsString, arg1, arg2)
 * 
 *  Version: RDI 1.51
 *
 *  Purpose: Set the string value of the specified property.
 *
 *           This is only supported for a particular module/agent handle
 *           and property id, if that property had indicated it supports
 *           'asString' access.
 *
 *           Note that all properties in the same group are considered
 *           related, so that if any property in a group is changed then all
 *           others in that group should be reread.  This allows several
 *           properties in a group to be dependent on each other.
 *
 *           If the debug controller is offering a flat display of properties,
 *           using the RDIPropertyGroup_SuperGroup group, then it should
 *           re-read all properties whenever a single property gets set.
 *
 *   Params:
 *       Input: mh      handle identifies debug agent / processor / thread
 *
 *              type    RDIProperty_SetAsString
 *
 *              arg1    unsigned32 id
 *                      Property id as returned in the RDIProperty_Desc struct.
 *
 *      In/Out: arg2    void *buf
 *                      The caller passes in a buffer containing the new value
 *                      for the specified property. Note that the string must
 *                      not be longer that the maxLen field in the
 *                      RDIProperty_Desc struct.
 *   
 *   Returns:
 *         OK:  RDIError_NoError - no error
 *       Error: RDIError_NoSuchHandle - the property was specified incorrectly
 *                                      (ie. the one specified does not exist).
 *       Error: RDIError_ReadOnly - this variable is readonly - request ignored
 *       Error: RDIError_BadValue - value specified was illegal for this
 *                                  variable request ignored.
 */
#define RDIProperty_SetAsString 0x706


/*
 * Function:    RDI_InfoProc(mh, RDIProperty_GetPropertyDisplayDetails,
 *              arg1, arg2)
 * 
 *  Version:    RDI 1.51
 *
 *  Purpose:    Get display details for the specified property.
 *
 *              This is only supported for a particular module/agent handle
 *              if RDIProperty_RequestCategories returns RDIError_NoError,
 *              and even then support of this function is optional.
 *
 *   Params:
 *       Input: mh      handle identifies agent/processor
 *
 *              type    RDIProperty_GetPropertyDisplayDetails
 *
 *              arg1    RDIProperty_Desc *prop
 *                      Contains property identification information.
 *
 *      In/Out: arg2    void *buf
 *                      The caller passes in a buffer of sufficient size for
 *                      whatever property display details are to be returned.
 *                      How much space will be required and what gets returned
 *                      depends entirely on the RDIProperty_DisplayType
 *                      for the specified property.  For details see the
 *                      descriptions of the various property display types,
 *                      given with the RDIProperty_DisplayType enumeration.
 *                     
 *   
 *   Returns:   RDIError_NoError - no error
 *              RDIError_NoSuchHandle - the property was specified incorrectly
 *                       (ie. the one specified does not exist).
 *              RDIError_BufferFull - the buffer passed was not big enough.
 */
#define RDI_GetPropertyDisplayDetails 0x707

/*
 * End of RDI Properties
 */


/* RESERVED PROPERTY-ID VALUES */
/*
 * 1 .. 8 are ARMSignal_IRQ thru ARMSignal_WaitForInterrupt -
 *   see armulif/armsignal.h in the plugin-model kit.
 *  ARMSignal_IRQ = 1,
 *  ARMSignal_FIQ,
 *  ARMSignal_Reset,
 *  ARMSignal_BigEnd,
 *  ARMSignal_HighException,
 *  ARMSignal_BranchPredictEnable,
 *  ARMSignal_LDRSetTBITDisable,
 *  ARMSignal_WaitForInterrupt = 8
 *
 * See also armulif/armul_propid.h for
 *    ARMulProp_CycleCount = 100,
 *   ARMulProp_CycleDelta,
 *    ARMulProp_LSUBusyUntil = 102.
 */

#endif /* !def rdi_prop_h */

/* EOF rdi_prop.h */