Specification of GPT Driver - AUTOSAR

1 Specification of GPT Driver AUTOSAR CP Release 1 of 65 Document ID 030: AUTOSAR_SWS_GPTD river - AUTOSAR confidential - Document Title Specification of GPT Driver Document Owner AUTOSAR Document Responsibility AUTOSAR Document Identification No 030 Document Status Final Part of AUTOSAR Standard Classic Platform Part of Standard Release Document Change History Date Release Changed by Change Description 2017-12-08 AUTOSAR Release Management Ensure consistency between default error tracer and development errors. Add support of runtime errors and change type of errors GPT_E_MODE and GPT_E_BUSY. 2016-11-30 AUTOSAR Release Management Variant chapter reworked. Remove redundant requirement SWS_Gpt_00342. Remove any reference to Dem. 2015-07-31 AUTOSAR Release Management Det renaming and extension incorporation Debugging support marked as obsolete Remove duplicated requirements in traceability 2014-10-31 AUTOSAR Release Management Init pointer check harmonized with BSW_General, redundant SWS_GPT_00294, SWS_GPT_00340 items removed Added new error code GPT_E_INIT_FAILED 2013-10-31 AUTOSAR Release Management Editorial changes 2013-03-15 AUTOSAR Administration GPT Predef Timer functionality added Gpt_GetTimeElapsed and Gpt_GetTimeRemaining are fully reentrant now renamed to Specification of GPT Driver AUTOSAR CP Release 2 of 65 Document ID 030.

2 AUTOSAR_SWS_GPTD river - AUTOSAR confidential - Document Change History Date Release Changed by Change Description 2011-12-22 AUTOSAR Administration Range added to ECUC_Gpt_00331 "module short name" replaced by "module abbreviation" Chapter 6 revised and chapter 13 added due to new traceability mechanism 2011-04-15 AUTOSAR Administration GPT208, GPT376 and GPT378 removed Multiplicity changed in ECUC_Gpt_00312 (chapter updated) SWS_Gpt_00256 rephrased SWS_Gpt_00256 changed according to changed SRS_BSW_00004 2009-12-18 AUTOSAR Administration Revised completely, a lot of SWS items deleted, replaced, changed and added Gpt_Cbk_CheckWakeup renamed to Gpt_CheckWakeup Parameter names of API services renamed Configuration parameters renamed, deleted and added Debugging Concept incorporated ClockReferencePoint mechanism incorporated Traceability tables updated Legal disclaimer revised Chapter revised 2008-08-13 AUTOSAR Administration Legal disclaimer revised Specification of GPT Driver AUTOSAR CP Release 3 of 65 Document ID 030: AUTOSAR_SWS_GPTD river - AUTOSAR confidential - Document Change History Date Release Changed by Change Description 2007-12-21 AUTOSAR Administration Introduction of consistent description of wakeup concept (as evaluated in Startup/ Wakeup Taskforce).

3 This includes modifications and extensions of textual descriptions as well as the modification of sequence charts related to wakeup. SWS Improvement: improvement of wording, alignment of API description Introduction of additional development error in case of already initialized module Document meta information extended Small layout adaptations made 2007-01-24 AUTOSAR Administration Header file structure changed significantly Return values and development errors for Gpt_GetTimeRemaining() and Gpt_GetTimeElapsed() changed Development error checking of ConfigPtr in Gpt_Init() changed Configuration container structure and configuration parameters changed Interface Dem_ReportErrorEvent() removed Legal disclaimer revised Release Notes added Advice for users revised Revision Information added 2006-05-16 AUTOSAR Administration Document structure adapted to common Release SWS Template. Added wake-up functionality For more details see chapter 11 2005-05-31 AUTOSAR Administration Initial release Specification of GPT Driver AUTOSAR CP Release 4 of 65 Document ID 030: AUTOSAR_SWS_GPTD river - AUTOSAR confidential - Specification of GPT Driver AUTOSAR CP Release 5 of 65 Document ID 030: AUTOSAR_SWS_GPTD river - AUTOSAR confidential - Disclaimer This work ( Specification and/or software implementation) and the material contained in it, as released by AUTOSAR , is for the purpose of information only.

4 AUTOSAR and the companies that have contributed to it shall not be liable for any use of the work. The material contained in this work is protected by copyright and other types of intellectual property rights. The commercial exploitation of the material contained in this work requires a license to such intellectual property rights. This work may be utilized or reproduced without any modification, in any form or by any means, for informational purposes only. For any other purpose, no part of the work may be utilized or reproduced, in any form or by any means, without permission in writing from the publisher. The work has been developed for automotive applications only. It has neither been developed, nor tested for non-automotive applications. The word AUTOSAR and the AUTOSAR logo are registered trademarks. Specification of GPT Driver AUTOSAR CP Release 6 of 65 Document ID 030: AUTOSAR_SWS_GPTD river - AUTOSAR confidential - Table of Contents 1 Introduction and functional overview.

5 8 2 Acronyms, abbreviations and terms .. 9 3 Related documentation .. 10 Input documents .. 10 Related standards and norms .. 11 Related Specification .. 11 4 Constraints and assumptions .. 12 Assumptions .. 12 Limitations .. 12 Applicability to car domains .. 12 5 Dependencies to other modules .. 13 6 Requirements traceability .. 15 7 Functional Specification .. 23 General behavior .. 23 GPT Predef Timers .. 26 Version checking .. 27 Error classification .. 28 Development Errors .. 28 Runtime Errors .. 28 Transient Faults .. 28 Production Errors .. 28 Extended Production Errors .. 28 Error detection .. 29 8 API Specification .. 30 Imported types .. 30 Type Definitions .. 30 Error notification .. 30 Gpt_ConfigType .. 30 Gpt_ChannelType .. 30 Gpt_ValueType .. 31 Gpt_ModeType .. 31 Gpt_PredefTimerType .. 31 Function 31 Gpt_GetVersionInfo .. 31 Gpt_Init .. 32 Gpt_DeInit .. 33 Gpt_GetTimeElapsed.

6 34 Gpt_GetTimeRemaining .. 36 Gpt_StartTimer .. 37 Gpt_StopTimer .. 38 Gpt_EnableNotification .. 39 Gpt_DisableNotification .. 40 Specification of GPT Driver AUTOSAR CP Release 7 of 65 Document ID 030: AUTOSAR_SWS_GPTD river - AUTOSAR confidential - 40 Gpt_DisableWakeup .. 42 Gpt_EnableWakeup .. 43 Gpt_CheckWakeup .. 44 Gpt_GetPredefTimerValue .. 45 Call-back Notifications .. 46 Scheduled functions .. 46 Expected Interfaces .. 46 Mandatory Interfaces .. 46 Optional Interfaces .. 47 Configurable Interfaces .. 47 9 Sequence diagrams .. 49 Gpt_Init .. 49 GPT continuous mode .. 50 GPT one-shot mode .. 51 Disable/Enable Notifications .. 52 Wakeup .. 53 10 Configuration Specification .. 54 How to read this chapter .. 54 Containers and configuration parameters .. 55 Variants .. 55 Gpt .. 56 GptDriverConfiguration .. 56 GptClockReferencePoint .. 58 GptChannelConfigSet .. 59 GptChannelConfiguration.

7 59 GptWakeupConfiguration .. 61 GptConfigurationOfOptApiServices .. 62 Published Information .. 64 11 Not applicable 65 Specification of GPT Driver AUTOSAR CP Release 8 of 65 Document ID 030: AUTOSAR_SWS_GPTD river - AUTOSAR confidential - 1 Introduction and functional overview This Specification specifies the functionality, API and the configuration of the AUTOSAR Basic Software module GPT Driver . The GPT Driver is part of the microcontroller abstraction layer (MCAL). It initializes and controls the internal General Purpose Timer(s) (GPT) of the microcontroller. The GPT Driver provides services and configuration parameters for Starting and stopping hardware timers Getting timer values Controlling time triggered interrupt notifications, if supported by hardware Controlling time triggered wakeup interrupts, if supported by hardware The tick duration of a timer channel depends on channel specific settings (part of GPT Driver ) as well as on system clock and settings of the clock tree controlled by the MCU module.

8 The tick duration is not limited by this Specification . Not all hardware timers must be controlled by the GPT module. Some timers may be controlled by AUTOSAR Operating System or Complex drivers directly. The number of timer channels controlled by the GPT Driver depends on hardware, implementation and system configuration. Beside the possibility to configure individual timer channels with individual properties, some free running up counters so-called GPT Predef Timers are defined. These timers have predefined tick durations and predefined number of bits (physical time units and ranges). The GPT Predef Timers are used by the Time Service module. The GPT Driver only generates time bases. Further time based functionality on Driver level is covered by other MCAL modules like: PWM Driver ( Driver for pulse width modulation) ICU Driver ( Driver for input capture unit) OCU Driver ( Driver for output compare unit) Specification of GPT Driver AUTOSAR CP Release 9 of 65 Document ID 030: AUTOSAR_SWS_GPTD river - AUTOSAR confidential - 2 Acronyms, abbreviations and terms Only a few acronyms and abbreviations are listed here which are helpful to understand this document or which have a local scope.

9 Further information can be found in the official AUTOSAR glossary [13]. Acronym / Abbreviation Description BSW Basic Software DET Default Error Tracer ECU Electronic Control Unit GPT General Purpose Timer ICU Input Capture Unit MCU Micro Controller Unit NOP, nop Null Operation OS Operating System Table 1: Acronyms and abbreviations The terms defined in the table below have a local scope within this document. Term Description Timer channel Represents a logical timer entity assigned to a timer hardware Target time Time, something shall occur, when the value is reached. The behavior depends on the configuration and the enabled functionality. Tick Defines the timer resolution, the duration of a timer increment GPT Predef Timer A GPT Predef Timer is a free running up counter provided by the GPT Driver . Which GPT Predef Timer(s) are available depends on hardware (clock, hardware timers, prescaler, width of timer register.)

10 And configuration. A GPT Predef Timer has predefined physical time unit and range. Table 2: Terms Specification of GPT Driver AUTOSAR CP Release 10 of 65 Document ID 030: AUTOSAR_SWS_GPTD river - AUTOSAR confidential - 3 Related documentation Input documents [1] List of Basic Software Modules, [2] Layered Software Architecture, [3] General Requirements on Basic Software Modules, [4] Specification of Standard Types, [5] Specification of Default Error Tracer, [6] Specification of ECU Configuration, [7] Specification of Diagnostic Event Manager, [8] Specification of ECU State Manager, [9] General Requirements on SPAL, [10] Requirements on GPT Driver , [11] Specification of ICU Driver , [12] Specification of MCU Driver , [13] Glossary, [14] Basic Software Module Description Template, Specification of GPT Driver AUTOSAR CP Release 11 of 65 Document ID 030: AUTOSAR_SWS_GPTD river - AUTOSAR confidential - [15] General Specification of Basic Software Modules, Related standards and norms [16] IEC 7498-1 The Basic Model, IEC Norm, 1994 Related Specification AUTOSAR provides a General Specification on Basic Software modules [15] (SWS BSW General), which is also valid for GPT Driver .