2416134_en-US

[#1]

LPIT GPT documentation missing

I'd like to use the LPIT GPT functionality of the LPit_Gpt IP driver module.
The S32K118 example shows various functions regarding this module, like "Lpit_Gpt_Ip_Init", "Lpit_Gpt_Ip_InitChannel" or "Lpit_Gpt_Ip_StartTimer".
However, when checking the corresponding User Manual or Integration Manual, none of those functions are listed.

Where can I find proper documentation?

RTD Version is 3.0.0 QLP06.

Re: LPIT GPT documentation missing

Hello @daniel_meier,

The User and Integration manuals are mainly describing the AUTOSAR high-level driver functions (which in consequence, use the lower-level functions). If you require further information about the IP lower-level APIs, you can refer to the LPit_Gpt_Ip.h header. 

For example, for Lpit_Gpt_Ip_Init:

/**
* @brief         Function Name : Lpit_Gpt_Ip_Init
* @details       Driver initialization function for LPit instance.
*
*
* @param[in]     instance     LPIT hw instance number
* @param[in]     config       Pointer to a selected configuration structure
* @return        void
* @pre           The data structure including the configuration set required for initializing the driver
*
*/
void Lpit_Gpt_Ip_Init(uint8 instance, const Lpit_Gpt_Ip_InstanceConfigType *config);

Best regards,
Julián

Re: LPIT GPT documentation missing

Thanks for the information.

I think having a proper and complete documentation independent from the source files is a must.

Either way, looks like I'll be able to generate some doxygen documentation myself from the sources.