A.8.17. CADI::CADIRegGetCompound()

This call gets the information about a compound register. The structure of the compound register is as reported by a call to CADIRegGetCompound(). Compound registers, that is, registers that contain subregisters, form an additional hierarchy below register groups.

virtual CADIReturn_t CADI::CADIRegGetCompound(uint32_t reg, 
                                              uint32_t componentIndex,
                                              uint32_t desiredNumOfComponents, 
                                              uint32_t *actualNumOfcomponents,
                                              uint32_t *components) = 0;

where:

reg

is the register number.

componentIndex

is the index into the internal component array for the requested register.

desiredNumOfComponents

is the total number of child registers required by the caller, starting at componentIndex.

actualNumOfcomponents

on return, is the number of components returned by the target. Any value set on input is ignored.

components

on return, is the list of component registers. The array is allocated, and deallocated if applicable, by the caller to be filled by the target. The amount of space allocated must be big enough to hold the number of requested components. If a target has written less than regCount registers it returns the number of registers successfully written in this field. The target must report an error only in the case of a cyclic graph where, for example, a compound register contains a register (component) that again is a compound register that owns a component that is the initially requested compound register.

Copyright © 2008-2014 ARM. All rights reserved.ARM DUI 0444M
Non-ConfidentialID051314