MCAL API Descrption

cancel
Showing results for 
Show  only  | Search instead for 
Did you mean: 

MCAL API Descrption

Jump to solution
860 Views
Embedded_novice
Contributor III

Currently, in the MCAL static code, I can only understand the usage of the API through the function comments. I would like to know if there are any documentation or websites available to query the explanations and parameter descriptions of each API in the MCAL API functions?

0 Kudos
Reply
1 Solution
822 Views
petervlna
NXP TechSupport
NXP TechSupport

Hello,

You are right. I do not see them in the API documentation.

Therefore I expect it could part of general AUTOSAR specification.

But I have only ASR 4.0 documentation here and I did not find it there.

As you shared, you can understand it from the code c and h files. Seems to me the quickest way to see the parameters.

Best regards,

Peter

View solution in original post

0 Kudos
Reply
3 Replies
842 Views
petervlna
NXP TechSupport
NXP TechSupport

Hello,

API documentation is present directly at plugins:

For example ADC:

petervlna_0-1750833454808.png

There is doc folder where you can find implementation and user manual.

best regards,

Peter

0 Kudos
Reply
841 Views
Embedded_novice
Contributor III
However, this seems to only include the outermost encapsulation interface. I was able to find the function Mcu_GetPllStatus, but the deeper-level function implementations within it, such as Mcu_Ipw_GetPllStatus, cannot be found in the manual. Can I understand it as follows: The manual only presents the API of the outermost layer, while the internal implementation API can only be understood through the comments?
0 Kudos
Reply
823 Views
petervlna
NXP TechSupport
NXP TechSupport

Hello,

You are right. I do not see them in the API documentation.

Therefore I expect it could part of general AUTOSAR specification.

But I have only ASR 4.0 documentation here and I did not find it there.

As you shared, you can understand it from the code c and h files. Seems to me the quickest way to see the parameters.

Best regards,

Peter

0 Kudos
Reply