SNIP_CLASSIC_ADC_SECTION_8_3_2_Adc_SetupResultBuffer

8.3.2 Adc_SetupResultBuffer [SWS_Adc_91000] Definition of API function Adc_SetupResultBuffer ⌈ Service Name Adc_SetupResultBuffer Syntax Std_ReturnType Adc_SetupResultBuffer ( Adc_GroupType Group, Adc_ValueGroupType* DataBufferPtr ) Service ID [hex] 0x0c Sync/Async Asynchronous Reentrancy Reentrant Group Numeric ID of requested ADC channel group. Parameters (in) DataBufferPtr pointer to result data buffer Parameters (inout) None ▽ △ Parameters (out) None Return value Std_ReturnType E_OK: result buffer pointer initialized correctly E_NOT_OK: operation failed or development error occured Description Initializes ADC driver with the group specific result buffer start address where the conversion results will be stored. The application has to ensure that the application buffer, where Data BufferPtr points to, can hold all the conversion results of the specified group. The initialization with Adc_SetupResultBuffer is required after reset, before a group conversion can be started. Available via Adc.h ⌋ [SWS_Adc_00420] ⌈The function Adc_SetupResultBuffer shall initialize the result buffer pointer of the selected group with the address value passed as parameter.⌋ [SWS_Adc_00421] ⌈The ADC module’s environment shall ensure that no group conversions are started without prior initialization of the according result buffer pointer to point to a valid result buffer.⌋ [SWS_Adc_00422] ⌈The ADC module’s environment shall ensure that the application buffer, which address is passed as parameter in Adc_SetupResultBuffer, has the according size to hold all group channel conversion results and if streaming access is selected, hold these results multiple times as specified with streaming sample parameter (see ADC292).⌋ [SWS_Adc_00423] ⌈If development error detection for the ADC module is enabled: if the channel group ID is non-existing, the function Adc_SetupResultBuffer shall raise development error ADC_E_PARAM_GROUP and return without any action.⌋ [SWS_Adc_00433] ⌈If called while group is not in state ADC_IDLE, function Adc_ SetupResultBuffer shall report a runtime error ADC_E_BUSY.⌋ [SWS_Adc_00434] ⌈If development error detection for the ADC module is enabled: when called prior to initializing the driver, the function Adc_SetupResultBuffer shall raise development error ADC_E_UNINIT.⌋ [SWS_Adc_00457] ⌈If development error detection for the ADC module is enabled: when called with a NULL_PTR as DataBufferPtr, the function Adc_SetupResultBuffer shall raise development error ADC_E_PARAM_POINTER.⌋