topic Re: SDK Software component and abstraction layer documentation in i.MX Processors

SDK Software component and abstraction layer documentation

patriciocohen — Wed, 29 Mar 2023 20:33:43 GMT

Hi,

Anyone knows where to find the documentation for the following SDK components:
They do not appear in the MCUXpresso SDK API Reference Manual.
I'm using the i.MXRT1062

Software components:
====================
button
led
lists
log
log_backend_debug_console
log_backend_ring_buffer
mem_manager
osa
panic
timer_manager

Abstraction Layer:
==================
gpt_adapter
igpio_adapter
lpi2c_adapter
lpspi_adapter
nor_flash-common
nor_flash-controller-flexspi
pit time stamp adapter
pit_adapter
sai_edma_adapter
software_crc_adapter
software_rng_adapter
trng_adapter

This post from 2021 exposes the problem: https://community.nxp.com/t5/MCUXpresso-SDK/Documentation-of-SDK-components-drivers-middleware-abstraction/m-p/1349217#M3370

Can someone at NXP point me where to get the information?

How are we supposed to use software libraries whose documentation is non existent?

Best regards,

Patricio

Re: SDK Software component and abstraction layer documentation

kerryzhou — Thu, 30 Mar 2023 07:54:00 GMT

Hi @patriciocohen ，

In fact, not all the SDK code have documents.

We normally check the source code directly instead of the document.

To the component and abstraction layer, no document available.

Please check the source code directly.

Sorry for the inconvenience we bring you.

Best Regards,

Kerry

Re: SDK Software component and abstraction layer documentation

patriciocohen — Thu, 30 Mar 2023 12:15:21 GMT

Hi Kerry,

Thanks for your reply. Please tell NXP management to consider documenting all software components, otherwise they are not very useful. Learning them directly from the source code is very time consuming and highly detrimental when you are against the clock, struggling to reduce time to market for your new product.

Since the documentation is not available, can you provide high level block diagrams where the interaction between different SDK components is shown? As an example, it would be useful to see how the OSA and each of the adapter drivers fit in the whole picture.

Is this going to be solved in the near future?

Best regards,

Patricio

Re: SDK Software component and abstraction layer documentation

kerryzhou — Fri, 31 Mar 2023 07:14:50 GMT

Hi @patriciocohen ,

To be honest, really no document for it. You also mentioned another community link, we have report it, but SDK side still didn't add the related document.

That's why the SDK provides the component example:

SDK_2_13_1_EVK-MIMXRT1060\boards\evkmimxrt1060\component_examples

You can analyze the project, then draw the code flow, then you can find the detail interaction between SDK components.

Best Regards,

Kerry

Wish it helps you!

Best Regards,

kerry

Re: SDK Software component and abstraction layer documentation

patriciocohen — Tue, 04 Apr 2023 17:44:40 GMT

Thank you Kerry

Re: SDK Software component and abstraction layer documentation

danielholala — Thu, 14 Sep 2023 06:43:03 GMT

I don't understand why this answer is marked as "solution". For the time being, there's no solution as the documentation is still unavailable, IMHO.

Re: SDK Software component and abstraction layer documentation

patriciocohen — Thu, 14 Sep 2023 07:54:41 GMT

You are right. I removed the solved status.

Patricio

Re: SDK Software component and abstraction layer documentation

kerryzhou — Thu, 14 Sep 2023 08:00:11 GMT

Hi @danielholala ,

Normally, the code API have the related comment, I think that comment and the code will helps the understanding more than the document.

So, when I use the related component, I also check the code comment and the code detail directly. This is my experience.

Best Regards,

Kerry