SNIP_CLASSIC_ADC_SECTION_8_3_5_Adc_StopGroupConversion

8.3.5 Adc_StopGroupConversion [SWS_Adc_00368] Definition of API function Adc_StopGroupConversion ⌈ Service Name Adc_StopGroupConversion Syntax void Adc_StopGroupConversion ( Adc_GroupType Group ) Service ID [hex] 0x03 Sync/Async Synchronous Reentrancy Reentrant Parameters (in) Group Numeric ID of requested ADC Channel group. Parameters (inout) None Parameters (out) None Return value None Description Stops the conversion of the requested ADC Channel group. Available via Adc.h ⌋ [SWS_Adc_00385] Upstream requirements: SRS_Adc_12364 ⌈When the ADC Channel Group is in one-shot and software-trigger mode, the function Adc_StopGroupConversion shall stop an ongoing conversion of the group.⌋ [SWS_Adc_00437] ⌈When the ADC Channel Group is in one-shot and software-trigger mode, the function Adc_StopGroupConversion shall remove a start/restart request of the group from the queue, if queuing is enabled and a start/restart request is stored in the queue.⌋ [SWS_Adc_00386] Upstream requirements: SRS_Adc_12364 ⌈When the ADC Channel Group is in continuous-conversion and software-trigger mode, the function Adc_StopGroupConversion shall stop an ongoing conversion of the group.⌋ [SWS_Adc_00438] ⌈When the ADC Channel Group is in continuous-conversion and software-trigger mode, the function Adc_StopGroupConversion shall remove a start/ restart request of the group from the queue, if queuing is enabled and a start/restart request is stored in the queue.⌋ [SWS_Adc_00155] Upstream requirements: SRS_Adc_12317 ⌈The function Adc_StopGroupConversion shall automatically disable group notification for the requested group.⌋ Note: Groups which are implicitly stopped shall not disable the group notification until Adc_ StopGroupConversion is called. [SWS_Adc_00360] ⌈The function Adc_StopGroupConversion shall set the group status to state ADC_IDLE.⌋ [SWS_Adc_00283] Upstream requirements: SRS_Adc_12817 ⌈The ADC module’s environment shall only call the function Adc_StopGroupConversion for groups configured with trigger source software.⌋ [SWS_Adc_00260] Upstream requirements: SRS_BSW_00171 ⌈The function Adc_StopGroupConversion shall be pre compile time configurable On/ Off by the configuration parameter AdcEnableStartStopGroupApi.⌋ [SWS_Adc_00126] Upstream requirements: SRS_BSW_00323, SRS_BSW_00386, SRS_SPAL_12448 ⌈If development error detection for the ADC module is enabled:if the group ID is non-existing, the function Adc_StopGroupConversion shall raise development error ADC_ E_PARAM_GROUP and return without any action.⌋ [SWS_Adc_00164] Upstream requirements: SRS_BSW_00386, SRS_SPAL_12448 ⌈If development error detection for the ADC module is enabled:if the group has a trigger source configured as hardware, function Adc_StopGroupConversion shall raise development error ADC_E_WRONG_TRIGG_SRC and return without any action.⌋ [SWS_Adc_00241] Upstream requirements: SRS_BSW_00323, SRS_BSW_00386, SRS_SPAL_12448 ⌈When called while the group is in state ADC_IDLE, the function Adc_StopGroupConversion shall report a runtime error ADC_E_IDLE.⌋ Note: For groups which are implicitly stopped (groups with conversion mode one-shot or groups with linear streaming buffer mode), state is ADC_STREAM_COMPLETED until results are accessed with Adc_ReadGroup or Adc_GetStreamLastPointer API functions or until group is explicitly stopped by Adc_StopGroupConversion API. [SWS_Adc_00295] Upstream requirements: SRS_BSW_00406 ⌈If development error detection for the ADC module is enabled: if called prior to initializing the module, function Adc_StopGroupConversion shall raise development error ADC_E_UNINIT and return without any action.⌋ Note: All groups which are started with Adc_StartGroupConversion should also be stopped with Adc_StopGroupConversion, before they are started again to reset the group status to ADC_IDLE. Exceptions to this rule are groups which are implicitly stopped because of the selected conversion mode (linear buffer with streaming access mode or one-shot conversion mode with single access).These groups can also be restarted while the group is in state ADC_STREAM_COMPLETED.