[MCUXSDK] Enable SDK components using Kconfig inside GitHub SDK

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

[MCUXSDK] Enable SDK components using Kconfig inside GitHub SDK

[MCUXSDK] Enable SDK components using Kconfig inside GitHub SDK

Hi,

Bellow you can find the necessary steps to enable SDK components when using GitHub SDK and Kconfig/CMake. This procedure is helpful for creating custom example applications that combine multiple SDK components..

Prerequisites:

Step 1:

Make sure that all SDK tools are up to date. For this, open the MCUXpresso Installer tool and click on the "Check for newer versions of components" button.

razvan_micu_2-1753713170462.png

Check that the MCUXpresso SDK Developer tools collection has a green checkmark next to it. Otherwise click on it to select it and after that click Install to update/install the package to it's latest version.

Step 2:

Use the import example application tool to import the base example that you want to modify for the board you are working with. 

razvan_micu_1-1753712888878.png

 

 Step 3:

Method 1: Editing the example prj.conf file

Once the project is imported you can see through "Project files" a file called "prj.conf" that contains example specific flags to set certain variables or enable specific SDK components .

razvan_micu_0-1753781974552.png

 

Here you can set the flags needed by the component/driver/middleware you wish to enable for your project. To see what flags are needed by a specific component you can check the component Kconfig file:

  • For drivers go to ../mcuxsdk/drivers/<driver-name>/Kconfig
  • For components go to ../mcuxsdk/components/<component-name>/Kconfig
  • For middleware go to ../mcuxsdk/middleware/<middleware-name>/Kconfig
     
Inside the Kconfig files you can also see if the component has any external dependencies that also need to be enabled. For example enabling the onboard LED there will be the following config dependencies:
 
razvan_micu_6-1753715355462.png

 

Method 2: Using Kconfig GUI configuration tool
 
Right click on the project->Configure->Open Kconfig GUI configuration. This will open a pop-up window with a list of all config/components available in the SDK.
 
razvan_micu_4-1753715032750.png

To search for a specific component or driver you can use the "Jump to.." button and type in the name of the component/driver and click search to list all available references:

 
razvan_micu_5-1753715231327.png

To enable a component, simply check it inside any window and click on Save in the main window of the tool after making your modifications.

Step 4: 

Rebuild the project with the new config to check for any incompatibilities. Right click on the project and select "Pristine Build/Rebuild the project" to perform a clean build of the project with the new configuration.

Note: Check the build logs to see any error/warnings of incompatibility between the components you have enabled previously.

For example trying to just enable the ehternet driver on a project without it's dependencies can cause the following warning that is easy to oversee but will result in the component not being actually activated and the project facing build errors further on:

razvan_micu_7-1753715965567.png

 

If the build finishes without any errors it means that the components were added  successfully to the project. You can now use the new drivers/components in your project. 

Best regards,
Razvan  

 

No ratings
Version history
Last update:
‎07-31-2025 04:10 AM
Updated by: