SNIP_CLASSIC_ADC_SECTION_8_3_7_Adc_EnableHardwareTrigger

8.3.7 Adc_EnableHardwareTrigger [SWS_Adc_91001] Definition of API function Adc_EnableHardwareTrigger ⌈ Service Name Adc_EnableHardwareTrigger Syntax void Adc_EnableHardwareTrigger ( Adc_GroupType Group ) Service ID [hex] 0x05 Sync/Async Asynchronous Reentrancy Reentrant Parameters (in) Group Numeric ID of requested ADC Channel group. Parameters (inout) None ▽ △ Parameters (out) None Return value None Description Enables the hardware trigger for the requested ADC Channel group. Available via Adc.h ⌋ [SWS_Adc_00114] Upstream requirements: SRS_Adc_12823 ⌈The function Adc_EnableHardwareTrigger shall enable the hardware trigger for the requested ADC Channel group.⌋ Note: Adc_EnableHardwareTrigger can only be used for ADC internal trigger sources controlled from the ADC hardware. [SWS_Adc_00144] Upstream requirements: SRS_Adc_12823 ⌈A group with trigger source hardware, whose trigger was enabled with Adc_Enable HardwareTrigger, shall execute the group channel conversions, whenever a trigger event occurs.⌋ [SWS_Adc_00432] ⌈The function Adc_EnableHardwareTrigger shall reset the internal group result buffer pointer, that conversion result storage always starts, after calling Adc_EnableHardwareTrigger, at the result buffer base address which was configured with Adc_SetupResultBuffer.⌋ [SWS_Adc_00273] Upstream requirements: SRS_Adc_12823 ⌈The ADC module’s environment shall guarantee that no concurrent conversions take place on the same HW Unit (happening of different hardware triggers at the same time).⌋ Note: The reason for SWS_Adc_00273 is that the ADC module can only handle one group conversion request per HW Unit at the same time. In case of concurrent HW conversion requests, the HW prioritization mechanism controls the conversion order. [SWS_Adc_00120] Upstream requirements: SRS_BSW_00171 ⌈The ADC module’s environment shall only call the function Adc_EnableHardwareTrigger for groups configured in hardware trigger mode (see AdcGroupTriggSrc).⌋ [SWS_Adc_00265] Upstream requirements: SRS_BSW_00171 ⌈The function Adc_EnableHardwareTrigger shall be pre-compile time configurable On/ Off by the configuration parameter AdcHwTriggerApi.⌋ [SWS_Adc_00321] ⌈If the priority mechanism is disabled and queuing disabled: when called while any group with trigger source SW is not in state ADC_IDLE, the function Adc_EnableHardwareTrigger shall report a runtime error ADC_E_BUSY.⌋ [SWS_Adc_00349] ⌈If the HW trigger for the group is already enabled, the function Adc_EnableHardwareTrigger shall report a runtime error ADC_E_BUSY.⌋ [SWS_Adc_00353] ⌈If the maximum number of available hardware triggers is already enabled (device and implementation specific), the function Adc_EnableHardwareTrigger shall report a runtime error ADC_E_BUSY.⌋ [SWS_Adc_00128] Upstream requirements: SRS_BSW_00323, SRS_BSW_00386, SRS_SPAL_12448 ⌈If development error detection for the ADC module is enabled: if the channel group ID is invalid, the function Adc_EnableHardwareTrigger shall raise development error ADC_E_PARAM_GROUP and return without any action.⌋ [SWS_Adc_00136] Upstream requirements: SRS_BSW_00386, SRS_SPAL_12448 ⌈If development error detection for the ADC module is enabled: if the group is configured for software API trigger mode, the function Adc_EnableHardwareTrigger shall raise development error ADC_E_WRONG_TRIGG_SRC and return without any action.⌋ [SWS_Adc_00281] Upstream requirements: SRS_Adc_12823 ⌈If development error detection for the ADC module is enabled: if a HW group is erroneously configured for continuous conversion mode, the function Adc_EnableHardwareTrigger shall raise development error ADC_E_WRONG_CONV_MODE and return without any action.⌋ Note: SW groups configured in continuous conversion mode shall raise development error ADC_E_WRONG_TRIGG_SRC instead. [SWS_Adc_00297] Upstream requirements: SRS_BSW_00406 ⌈If development error detection for the ADC module is enabled: if called prior to initializing the driver, the function Adc_EnableHardwareTrigger shall raise development error ADC_E_UNINIT and return without any action.⌋ [SWS_Adc_00425] ⌈If development error detection for the ADC module is enabled: when called prior to initializing the result buffer pointer with function Adc_SetupResult Buffer, the function Adc_EnableHardwareTrigger shall raise development error ADC_ E_BUFFER_UNINIT.⌋