LPIT GPT documentation missing

取消
显示结果 
显示  仅  | 搜索替代 
您的意思是: 
已解决

LPIT GPT documentation missing

跳至解决方案
690 次查看
daniel_meier
Contributor III

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.

标记 (1)
0 项奖励
回复
1 解答
668 次查看
Julián_AragónM
NXP TechSupport
NXP TechSupport

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

在原帖中查看解决方案

0 项奖励
回复
2 回复数
668 次查看
Julián_AragónM
NXP TechSupport
NXP TechSupport

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

0 项奖励
回复
576 次查看
daniel_meier
Contributor III

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.

0 项奖励
回复
%3CLINGO-SUB%20id%3D%22lingo-sub-2416134%22%20slang%3D%22en-US%22%20mode%3D%22CREATE%22%3ELPIT%20GPT%20%E6%96%87%E6%A1%A3%E7%BC%BA%E5%A4%B1%3C%2FLINGO-SUB%3E%3CLINGO-BODY%20id%3D%22lingo-body-2416134%22%20slang%3D%22en-US%22%20mode%3D%22CREATE%22%3E%3CP%3E%E6%88%91%E6%83%B3%E4%BD%BF%E7%94%A8%20LPit_Gpt%20IP%20%E9%A9%B1%E5%8A%A8%E6%A8%A1%E5%9D%97%E7%9A%84%20LPIT%20GPT%20%E5%8A%9F%E8%83%BD%E3%80%82%3CBR%20%2F%3ES32K118%20%E7%A4%BA%E4%BE%8B%E5%B1%95%E7%A4%BA%E4%BA%86%E4%B8%8E%E6%AD%A4%E6%A8%A1%E5%9D%97%E7%9B%B8%E5%85%B3%E7%9A%84%E5%90%84%E7%A7%8D%E5%8A%9F%E8%83%BD%EF%BC%8C%E4%BE%8B%E5%A6%82%E2%80%9C%20%3CSPAN%3ELpit_Gpt_Ip_Init%3C%2FSPAN%3E%20%E2%80%9D%E3%80%81%E2%80%9C%20%3CSPAN%3ELpit_Gpt_Ip_InitChannel%3C%2FSPAN%3E%20%E2%80%9D%E6%88%96%E2%80%9C%20%3CSPAN%3ELpit_Gpt_Ip_StartTimer%3C%2FSPAN%3E%20%E2%80%9D%E3%80%82%3CBR%20%2F%3E%E4%BD%86%E6%98%AF%EF%BC%8C%E5%9C%A8%E6%9F%A5%E9%98%85%E7%9B%B8%E5%BA%94%E7%9A%84%E7%94%A8%E6%88%B7%E6%89%8B%E5%86%8C%E6%88%96%E9%9B%86%E6%88%90%E6%89%8B%E5%86%8C%E6%97%B6%EF%BC%8C%E5%B9%B6%E6%9C%AA%E5%88%97%E5%87%BA%E8%BF%99%E4%BA%9B%E5%8A%9F%E8%83%BD%E3%80%82%3C%2FP%3E%3CP%3E%3CSTRONG%3E%E5%93%AA%E9%87%8C%E5%8F%AF%E4%BB%A5%E6%89%BE%E5%88%B0%E7%9B%B8%E5%85%B3%E6%96%87%E4%BB%B6%EF%BC%9F%3C%2FSTRONG%3E%3C%2FP%3E%3CP%3ERTD%20%E7%89%88%E6%9C%AC%E4%B8%BA%203.0.0QLP06%E3%80%82%3C%2FP%3E%3C%2FLINGO-BODY%3E%3CLINGO-SUB%20id%3D%22lingo-sub-2416171%22%20slang%3D%22en-US%22%20mode%3D%22CREATE%22%20translate%3D%22no%22%3ERe%3A%20LPIT%20GPT%20documentation%20missing%3C%2FLINGO-SUB%3E%3CLINGO-BODY%20id%3D%22lingo-body-2416171%22%20slang%3D%22en-US%22%20mode%3D%22CREATE%22%3E%3CP%3E%E4%BD%A0%E5%A5%BD%3CA%20href%3D%22https%3A%2F%2Fcommunity.nxp.com%2Ft5%2Fuser%2Fviewprofilepage%2Fuser-id%2F168838%22%20target%3D%22_blank%22%3E%40daniel_meier%3C%2FA%3E%20%EF%BC%8C%3C%2FP%3E%0A%3CP%3E%E7%94%A8%E6%88%B7%E5%92%8C%E9%9B%86%E6%88%90%E6%89%8B%E5%86%8C%E4%B8%BB%E8%A6%81%E6%8F%8F%E8%BF%B0%E4%BA%86%20AUTOSAR%20%E9%AB%98%E7%BA%A7%E9%A9%B1%E5%8A%A8%E7%A8%8B%E5%BA%8F%E5%8A%9F%E8%83%BD%EF%BC%88%E5%9B%A0%E6%AD%A4%EF%BC%8C%E8%BF%99%E4%BA%9B%E5%8A%9F%E8%83%BD%E4%BC%9A%E4%BD%BF%E7%94%A8%E4%BD%8E%E7%BA%A7%E5%8A%9F%E8%83%BD%EF%BC%89%E3%80%82%E5%A6%82%E6%9E%9C%E6%82%A8%E9%9C%80%E8%A6%81%E6%9C%89%E5%85%B3%20IP%20%E5%BA%95%E5%B1%82%20API%20%E7%9A%84%E6%9B%B4%E5%A4%9A%E4%BF%A1%E6%81%AF%EF%BC%8C%E5%8F%AF%E4%BB%A5%E5%8F%82%E8%80%83%3CSTRONG%3ELPit_Gpt_Ip.h%3C%2FSTRONG%3E%E6%96%87%E4%BB%B6%E3%80%82%E6%A0%87%E9%A2%98%E3%80%82%3C%2FP%3E%0A%3CP%3E%E4%BE%8B%E5%A6%82%EF%BC%8C%E5%AF%B9%E4%BA%8E%3CSPAN%3E%3CSTRONG%3ELpit_Gpt_Ip_Init%3C%2FSTRONG%3E%20%EF%BC%9A%3C%2FSPAN%3E%3C%2FP%3E%0A%3CPRE%20class%3D%22lia-code-sample%20language-c%22%3E%3CCODE%20translate%3D%22no%22%3E%2F**%0A*%20%40brief%20%20%20%20%20%20%20%20%20Function%20Name%20%3A%20Lpit_Gpt_Ip_Init%0A*%20%40details%20%20%20%20%20%20%20Driver%20initialization%20function%20for%20LPit%20instance.%0A*%0A*%0A*%20%40param%5Bin%5D%20%20%20%20%20instance%20%20%20%20%20LPIT%20hw%20instance%20number%0A*%20%40param%5Bin%5D%20%20%20%20%20config%20%20%20%20%20%20%20Pointer%20to%20a%20selected%20configuration%20structure%0A*%20%40return%20%20%20%20%20%20%20%20void%0A*%20%40pre%20%20%20%20%20%20%20%20%20%20%20The%20data%20structure%20including%20the%20configuration%20set%20required%20for%20initializing%20the%20driver%0A*%0A*%2F%0Avoid%20Lpit_Gpt_Ip_Init(uint8%20instance%2C%20const%20Lpit_Gpt_Ip_InstanceConfigType%20*config)%3B%3C%2FCODE%3E%3C%2FPRE%3E%0A%3CP%3E%E6%AD%A4%E8%87%B4%EF%BC%8C%3CBR%20%2F%3E%E6%9C%B1%E5%88%A9%E5%AE%89%3C%2FP%3E%3C%2FLINGO-BODY%3E%3CLINGO-SUB%20id%3D%22lingo-sub-2417682%22%20slang%3D%22en-US%22%20mode%3D%22CREATE%22%20translate%3D%22no%22%3ERe%3A%20LPIT%20GPT%20documentation%20missing%3C%2FLINGO-SUB%3E%3CLINGO-BODY%20id%3D%22lingo-body-2417682%22%20slang%3D%22en-US%22%20mode%3D%22CREATE%22%3E%3CP%3E%E6%84%9F%E8%B0%A2%E4%BD%A0%E6%8F%90%E4%BE%9B%E7%9A%84%E4%BF%A1%E6%81%AF%E3%80%82%3C%2FP%3E%3CP%3E%E6%88%91%E8%AE%A4%E4%B8%BA%E6%8B%A5%E6%9C%89%E7%8B%AC%E7%AB%8B%E4%BA%8E%E6%BA%90%E6%96%87%E4%BB%B6%E7%9A%84%E5%AE%8C%E6%95%B4%E4%B8%94%E8%A7%84%E8%8C%83%E7%9A%84%E6%96%87%E6%A1%A3%E6%98%AF%E5%BF%85%E4%B8%8D%E5%8F%AF%E5%B0%91%E7%9A%84%E3%80%82%3C%2FP%3E%3CP%3E%E6%97%A0%E8%AE%BA%E5%A6%82%E4%BD%95%EF%BC%8C%E7%9C%8B%E6%9D%A5%E6%88%91%E5%8F%AF%E4%BB%A5%E6%A0%B9%E6%8D%AE%E6%BA%90%E4%BB%A3%E7%A0%81%E8%87%AA%E5%B7%B1%E7%94%9F%E6%88%90%E4%B8%80%E4%BA%9B%20Doxygen%20%E6%96%87%E6%A1%A3%E3%80%82%3C%2FP%3E%3C%2FLINGO-BODY%3E