driver documentation missing header information

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

driver documentation missing header information

87 Views
daniel_meier
Contributor II

I am developing a project for a S32K116 inside S32DS.
By now I figured out how the RTD works regarding to IP Drivers vs MCAL/AUTOSAR.
I will limit my project to the IP Drivers for now due to possible resource constraints.

I also figured out that I can find documentation about an IP Driver component by rightclicking on it inside the Components view. 

However, I found that it is not listed inside the documentation which headers to include for each driver when using one of the described functions.
How am I supposed to know that information? Is there a different document or list where this is specified?

0 Kudos
Reply
1 Reply

59 Views
Julián_AragónM
NXP TechSupport
NXP TechSupport

Hello 

USually, the top-level public header for each IP driver follows the naming convention <IpName>_Ip.h (e.g. Flexcan_Ip.h, Lpspi_Ip.h, Clock_Ip.h, Adc_Sar_Ip.h). That header is what you include in your source application code.

You can also look at the examples provided inside the RTD for which header files to include:

Julin_AragnM_1-1789513358457.pngJulin_AragnM_1-1789513358457.png

  • FlexCAN -> FlexCAN_Ip.h
  • Platform/Interrupt Controller -> IntCtrl_Ip.h
  • Port/Siul2 -> Siul2_Port_Ip.h
  • Dio/Siul2 -> Siul2_Dio_Ip.h

You can look for these header files inside the RTD installation path: "C:\NXP\S32DS.3.x.x\S32DS\software\PlatformSDK_S32K1_S32M24\RTD\<driver_module>_TS_...\include\"

Best regards,
Julián

 

0 Kudos
Reply
%3CLINGO-SUB%20id%3D%22lingo-sub-2413764%22%20slang%3D%22en-US%22%20mode%3D%22CREATE%22%3Edriver%20documentation%20missing%20header%20information%3C%2FLINGO-SUB%3E%3CLINGO-BODY%20id%3D%22lingo-body-2413764%22%20slang%3D%22en-US%22%20mode%3D%22CREATE%22%3E%3CP%3EI%20am%20developing%20a%20project%20for%20a%20S32K116%20inside%20S32DS.%3CBR%20%2F%3EBy%20now%20I%20figured%20out%20how%20the%20RTD%20works%20regarding%20to%20IP%20Drivers%20vs%20MCAL%2FAUTOSAR.%3CBR%20%2F%3EI%20will%20limit%20my%20project%20to%20the%20IP%20Drivers%20for%20now%20due%20to%20possible%20resource%20constraints.%3C%2FP%3E%3CP%3EI%20also%20figured%20out%20that%20I%20can%20find%20documentation%20about%20an%20IP%20Driver%20component%20by%20rightclicking%20on%20it%20inside%20the%20Components%20view.%26nbsp%3B%3C%2FP%3E%3CP%3EHowever%2C%20I%20found%20that%20it%20is%20%3CSTRONG%3Enot%3C%2FSTRONG%3E%20listed%20inside%20the%20documentation%20which%20%3CSTRONG%3Eheaders%3C%2FSTRONG%3E%20to%20include%20for%20each%20driver%20when%20using%20one%20of%20the%20described%20functions.%3CBR%20%2F%3EHow%20am%20I%20supposed%20to%20know%20that%20information%3F%20Is%20there%20a%20different%20document%20or%20list%20where%20this%20is%20specified%3F%3C%2FP%3E%3C%2FLINGO-BODY%3E%3CLINGO-SUB%20id%3D%22lingo-sub-2413812%22%20slang%3D%22en-US%22%20mode%3D%22CREATE%22%20translate%3D%22no%22%3ERe%3A%20driver%20documentation%20missing%20header%20information%3C%2FLINGO-SUB%3E%3CLINGO-BODY%20id%3D%22lingo-body-2413812%22%20slang%3D%22en-US%22%20mode%3D%22CREATE%22%3E%3CP%3EHello%26nbsp%3B%3C%2FP%3E%0A%3CP%3EUSually%2C%20the%20top-level%20public%20header%20for%20each%20IP%20driver%20follows%20the%20naming%20convention%20%3CIPNAME%3E_Ip.h%20(e.g.%20Flexcan_Ip.h%2C%20Lpspi_Ip.h%2C%20Clock_Ip.h%2C%20Adc_Sar_Ip.h).%20That%20header%20is%20what%20you%20include%20in%20your%20source%20application%20code.%3C%2FIPNAME%3E%3C%2FP%3E%0A%3CP%3EYou%20can%20also%20look%20at%20the%20examples%20provided%20inside%20the%20RTD%20for%20which%20header%20files%20to%20include%3A%3C%2FP%3E%0A%3CP%3E%3CSPAN%20class%3D%22lia-inline-image-display-wrapper%20lia-image-align-inline%22%20image-alt%3D%22Julin_AragnM_1-1789513358457.png%22%20style%3D%22width%3A%20999px%3B%22%3E%3Cspan%20class%3D%22lia-inline-image-display-wrapper%22%20image-alt%3D%22Julin_AragnM_1-1789513358457.png%22%20style%3D%22width%3A%20999px%3B%22%3E%3Cimg%20src%3D%22https%3A%2F%2Fcommunity.nxp.com%2Ft5%2Fimage%2Fserverpage%2Fimage-id%2F396434i5BF068733ED17843%2Fimage-size%2Flarge%3Fv%3Dv2%26amp%3Bpx%3D999%22%20role%3D%22button%22%20title%3D%22Julin_AragnM_1-1789513358457.png%22%20alt%3D%22Julin_AragnM_1-1789513358457.png%22%20%2F%3E%3Cspan%20class%3D%22lia-inline-image-caption%22%20onclick%3D%22event.preventDefault()%3B%22%3EJulin_AragnM_1-1789513358457.png%3C%2Fspan%3E%3C%2Fspan%3E%3CSPAN%20class%3D%22lia-inline-image-caption%22%20onclick%3D%22event.preventDefault()%3B%22%3EJulin_AragnM_1-1789513358457.png%3C%2FSPAN%3E%3C%2FSPAN%3E%3C%2FP%3E%0A%3CUL%3E%0A%3CLI%3EFlexCAN%20-%26gt%3B%20FlexCAN_Ip.h%3C%2FLI%3E%0A%3CLI%3EPlatform%2FInterrupt%20Controller%20-%26gt%3B%20IntCtrl_Ip.h%3C%2FLI%3E%0A%3CLI%3EPort%2FSiul2%20-%26gt%3B%20Siul2_Port_Ip.h%3C%2FLI%3E%0A%3CLI%3EDio%2FSiul2%20-%26gt%3B%20Siul2_Dio_Ip.h%3C%2FLI%3E%0A%3C%2FUL%3E%0A%3CP%3EYou%20can%20look%20for%20these%20header%20files%20inside%20the%20RTD%20installation%20path%3A%20%22C%3A%5CNXP%5CS32DS.3.x.x%5CS32DS%5Csoftware%5CPlatformSDK_S32K1_S32M24%5CRTD%5C%3CDRIVER_MODULE%3E_TS_...%5Cinclude%5C%22%3C%2FDRIVER_MODULE%3E%3C%2FP%3E%0A%3CP%3EBest%20regards%2C%3CBR%20%2F%3EJuli%C3%A1n%3C%2FP%3E%0A%3CBR%20%2F%3E%3C%2FLINGO-BODY%3E