Gpt

This section introduces the Generic Purpose Timer (GPT), including terms and acronyms, supported features. More...

Overview

This section introduces the Generic Purpose Timer (GPT), including terms and acronyms, supported features.

And any simple usage with these APIs and current system case of GPT are introduced in the section on how to use this driver.

Terms and Acronyms

Terms	Details
GPT	Generic Purpose Timer
ISR	Interrupt Service Routines

Supported Features

See Supported Features for the details of Supported Features.

How to use this driver

• Device driver sample code is as follows:
  
  • sample code (this is the user application sample code on freeRTos):

    - Initialize GPT driver:
         - Call mtk_os_hal_gpt_init() to initialize GPT driver.
    
    - Configure GPT0 as repeat mode (GPT1 is similar):
        - Define a variable "struct os_gpt_int gpt0_int".
      - Call mtk_os_hal_gpt_config(0, 0, &gpt0_int) to configure GPT0 clock
         speed (as 1KHz) and register GPT0 user interrupt callback handle
         and user data.
      - Call mtk_os_hal_gpt_reset_timer(0, 1000, true) to configure GPT0
         timeout value (as 1 second) and configure it as repeat mode.
    
    - Configure GPT3 as one-shot mode (GPT0 and GPT1 are similar):
    - Define a variable "struct os_gpt_int gpt3_int".
      - Call mtk_os_hal_gpt_config(3, 0, &gpt3_int) to configure GPT3 clock
         speed (for GPT3 default as 1MHz) and register GPT3 user interrupt
         callback handle and user data.
      - Call mtk_os_hal_gpt_reset_timer(3, 1000000, false) to configure GPT3
         timeout value (as 1 second) and configure it as one-shot mode.
    
    - Configure GPT2 (in free-run mode, and GPT4 is similar):
      - Call mtk_os_hal_gpt_config(2, 1, NULL) to configure GPT2 clock
         speed (for GPT2 as 32KHz).
    
    - Enable/disable GPTx (x = 0 ~ 4):
      - Call mtk_os_hal_gpt_start(x) and mtk_os_hal_gpt_stop(x) to enable/
         disable GPTx.
    
    - Get GPTx (x = 0 ~ 4) counter value:
      - Call mtk_os_hal_gpt_get_cur_count(x) to get GPTx counter value.

Modules
	Enum
	This section introduces the enumerations that specify the timer ID (Follow mhal_gpt.h) of the current GPT device unit.
	Function
	This section provides high level APIs to upper layer.
	Struct
	This section introduces the definition of GPT user interrupt handle structure.