# lv_nuttx_entry.h (/api/drivers/nuttx/lv_nuttx_entry_h)



<ApiSummary functions="7" structs="3" typedefs="1" />

Functions [#functions]

<ApiTabs items="[&#x22;Getters (1)&#x22;,&#x22;Other (6)&#x22;]">
  <ApiTab value="Getters (1)">
    <ApiMember kind="function" name="lv_nuttx_get_idle" file="drivers/nuttx/lv_nuttx_entry.h" line="104" url="https://github.com/lvgl/lvgl/tree/a7b95c5b0839ce901c09c205610bc2c77cc3345d/src/drivers/nuttx/lv_nuttx_entry.h#L104">
      lv_nuttx_get_idle [#lv_nuttx_get_idle]

      Get the idle percentage of the system.

      ```c title=" " lineNumbers=1
      uint32_t lv_nuttx_get_idle(void)
      ```

      **Returns:** <ApiLink name="uint32_t" /> — The idle percentage of the system.
    </ApiMember>
  </ApiTab>

  <ApiTab value="Other (6)">
    <ApiMember kind="function" name="lv_nuttx_dsc_init" file="drivers/nuttx/lv_nuttx_entry.h" line="62" url="https://github.com/lvgl/lvgl/tree/a7b95c5b0839ce901c09c205610bc2c77cc3345d/src/drivers/nuttx/lv_nuttx_entry.h#L62">
      lv_nuttx_dsc_init [#lv_nuttx_dsc_init]

      Initialize the <ApiLink name="lv_nuttx_dsc_t" /> structure with default values for the NuttX port of LVGL.

      ```c title=" " lineNumbers=1
      void lv_nuttx_dsc_init(lv_nuttx_dsc_t *dsc)
      ```

      <span className="sr-only">
        Parameters
      </span>

      | Name  | Type                                                         | Description                                                                   |
      | ----- | ------------------------------------------------------------ | ----------------------------------------------------------------------------- |
      | `dsc` | <ApiLink name="lv_nuttx_dsc_t" display="lv_nuttx_dsc_t *" /> | Pointer to the <ApiLink name="lv_nuttx_dsc_t" /> structure to be initialized. |
    </ApiMember>

    <ApiMember kind="function" name="lv_nuttx_init" file="drivers/nuttx/lv_nuttx_entry.h" line="69" url="https://github.com/lvgl/lvgl/tree/a7b95c5b0839ce901c09c205610bc2c77cc3345d/src/drivers/nuttx/lv_nuttx_entry.h#L69">
      lv_nuttx_init [#lv_nuttx_init]

      Initialize the LVGL display driver for NuttX using the provided configuration information.

      ```c title=" " lineNumbers=1
      void lv_nuttx_init(const lv_nuttx_dsc_t *dsc, lv_nuttx_result_t *result)
      ```

      <span className="sr-only">
        Parameters
      </span>

      | Name     | Type                                                               | Description                                                                                                                 |
      | -------- | ------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------- |
      | `dsc`    | <ApiLink name="lv_nuttx_dsc_t" display="const lv_nuttx_dsc_t *" /> | Pointer to the <ApiLink name="lv_nuttx_dsc_t" /> structure containing the configuration information for the display driver. |
      | `result` | <ApiLink name="lv_nuttx_result_t" display="lv_nuttx_result_t *" /> | Pointer to the <ApiLink name="lv_nuttx_result_t" /> structure containing display and input device handler.                  |
    </ApiMember>

    <ApiMember kind="function" name="lv_nuttx_deinit" file="drivers/nuttx/lv_nuttx_entry.h" line="75" url="https://github.com/lvgl/lvgl/tree/a7b95c5b0839ce901c09c205610bc2c77cc3345d/src/drivers/nuttx/lv_nuttx_entry.h#L75">
      lv_nuttx_deinit [#lv_nuttx_deinit]

      Deinitialize the LVGL display driver for NuttX.

      ```c title=" " lineNumbers=1
      void lv_nuttx_deinit(lv_nuttx_result_t *result)
      ```

      <span className="sr-only">
        Parameters
      </span>

      | Name     | Type                                                               | Description                                                                                                |
      | -------- | ------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------- |
      | `result` | <ApiLink name="lv_nuttx_result_t" display="lv_nuttx_result_t *" /> | Pointer to the <ApiLink name="lv_nuttx_result_t" /> structure containing display and input device handler. |
    </ApiMember>

    <ApiMember kind="function" name="lv_nuttx_init_custom" file="drivers/nuttx/lv_nuttx_entry.h" line="83" url="https://github.com/lvgl/lvgl/tree/a7b95c5b0839ce901c09c205610bc2c77cc3345d/src/drivers/nuttx/lv_nuttx_entry.h#L83">
      lv_nuttx_init_custom [#lv_nuttx_init_custom]

      Initialize the LVGL display driver for NuttX using the provided custom configuration information.

      ```c title=" " lineNumbers=1
      void lv_nuttx_init_custom(const lv_nuttx_dsc_t *dsc, lv_nuttx_result_t *result)
      ```

      <span className="sr-only">
        Parameters
      </span>

      | Name     | Type                                                               | Description                                                                                                            |
      | -------- | ------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------- |
      | `dsc`    | <ApiLink name="lv_nuttx_dsc_t" display="const lv_nuttx_dsc_t *" /> | Pointer to the <ApiLink name="lv_nuttx_dsc_t" /> structure containing the custom configuration for the display driver. |
      | `result` | <ApiLink name="lv_nuttx_result_t" display="lv_nuttx_result_t *" /> | Pointer to the <ApiLink name="lv_nuttx_result_t" /> structure containing display and input device handler.             |
    </ApiMember>

    <ApiMember kind="function" name="lv_nuttx_deinit_custom" file="drivers/nuttx/lv_nuttx_entry.h" line="89" url="https://github.com/lvgl/lvgl/tree/a7b95c5b0839ce901c09c205610bc2c77cc3345d/src/drivers/nuttx/lv_nuttx_entry.h#L89">
      lv_nuttx_deinit_custom [#lv_nuttx_deinit_custom]

      Deinitialize the LVGL display driver for NuttX using the provided custom configuration information.

      ```c title=" " lineNumbers=1
      void lv_nuttx_deinit_custom(lv_nuttx_result_t *result)
      ```

      <span className="sr-only">
        Parameters
      </span>

      | Name     | Type                                                               | Description                                                                                                |
      | -------- | ------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------- |
      | `result` | <ApiLink name="lv_nuttx_result_t" display="lv_nuttx_result_t *" /> | Pointer to the <ApiLink name="lv_nuttx_result_t" /> structure containing display and input device handler. |
    </ApiMember>

    <ApiMember kind="function" name="lv_nuttx_run" file="drivers/nuttx/lv_nuttx_entry.h" line="98" url="https://github.com/lvgl/lvgl/tree/a7b95c5b0839ce901c09c205610bc2c77cc3345d/src/drivers/nuttx/lv_nuttx_entry.h#L98">
      lv_nuttx_run [#lv_nuttx_run]

      Call <ApiLink name="lv_timer_handler" display="lv_timer_handler()" /> (LVGL's super loop) in an endless loop. If LV\_USE\_NUTTX\_LIBUV is enabled an UV timer will be created, else <ApiLink name="lv_timer_handler" display="lv_timer_handler()" /> will be called in a loop with some sleep.

      ```c title=" " lineNumbers=1
      void lv_nuttx_run(lv_nuttx_result_t *result)
      ```

      <span className="sr-only">
        Parameters
      </span>

      | Name     | Type                                                               | Description                                                                                                                                                                 |
      | -------- | ------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
      | `result` | <ApiLink name="lv_nuttx_result_t" display="lv_nuttx_result_t *" /> | pointer to a variable initialized by <ApiLink name="lv_nuttx_init" display="lv_nuttx_init()" /> or <ApiLink name="lv_nuttx_init_custom" display="lv_nuttx_init_custom()" /> |
    </ApiMember>
  </ApiTab>
</ApiTabs>

Structs [#structs]

<ApiMember kind="struct" name="lv_nuttx_dsc_t">
  lv_nuttx_dsc_t [#lv_nuttx_dsc_t]

  | Member        | Type           | Description |
  | ------------- | -------------- | ----------- |
  | `fb_path`     | `const char *` |             |
  | `input_path`  | `const char *` |             |
  | `utouch_path` | `const char *` |             |
  | `mouse_path`  | `const char *` |             |
  | `trace_path`  | `const char *` |             |
</ApiMember>

<TypeUsedBy name="lv_nuttx_dsc_t" count="3">
  * `lv_nuttx_dsc_init` — param `dsc`
  * `lv_nuttx_init` — param `dsc`
  * `lv_nuttx_init_custom` — param `dsc`
</TypeUsedBy>

<ApiMember kind="struct" name="lv_nuttx_result_t">
  lv_nuttx_result_t [#lv_nuttx_result_t]

  | Member         | Type                                                     | Description |
  | -------------- | -------------------------------------------------------- | ----------- |
  | `disp`         | <ApiLink name="lv_display_t" display="lv_display_t *" /> |             |
  | `indev`        | <ApiLink name="lv_indev_t" display="lv_indev_t *" />     |             |
  | `utouch_indev` | <ApiLink name="lv_indev_t" display="lv_indev_t *" />     |             |
  | `mouse_indev`  | <ApiLink name="lv_indev_t" display="lv_indev_t *" />     |             |
</ApiMember>

<TypeUsedBy name="lv_nuttx_result_t" count="5">
  * `lv_nuttx_init` — param `result`
  * `lv_nuttx_deinit` — param `result`
  * `lv_nuttx_init_custom` — param `result`
  * `lv_nuttx_deinit_custom` — param `result`
  * `lv_nuttx_run` — param `result`
</TypeUsedBy>

<ApiMember kind="struct" name="_lv_nuttx_ctx_t">
  \_lv_nuttx_ctx_t [#_lv_nuttx_ctx_t]

  | Member        | Type     | Description |
  | ------------- | -------- | ----------- |
  | `image_cache` | `void *` |             |
  | `trace_fd`    | `int`    |             |
</ApiMember>

Typedefs [#typedefs]

<ApiMember kind="typedef" name="lv_nuttx_ctx_t" file="drivers/nuttx/lv_nuttx_entry.h" line="52" url="https://github.com/lvgl/lvgl/tree/a7b95c5b0839ce901c09c205610bc2c77cc3345d/src/drivers/nuttx/lv_nuttx_entry.h#L52">
  lv_nuttx_ctx_t [#lv_nuttx_ctx_t]

  ```c title=" " lineNumbers=1
  typedef struct _lv_nuttx_ctx_t lv_nuttx_ctx_t
  ```
</ApiMember>

Dependencies [#dependencies]

<FileIncludes includes="[&#x22;lv_conf_internal.h&#x22;, &#x22;lv_display.h&#x22;, &#x22;lv_indev.h&#x22;]" includedBy="[&#x22;lv_drivers.h&#x22;]" transitiveIncludes="[&#x22;lv_area.h&#x22;, &#x22;lv_array.h&#x22;, &#x22;lv_assert.h&#x22;, &#x22;lv_color.h&#x22;, &#x22;lv_color_op.h&#x22;, &#x22;lv_conf_kconfig.h&#x22;, &#x22;lv_event.h&#x22;, &#x22;lv_group.h&#x22;, &#x22;lv_ll.h&#x22;, &#x22;lv_log.h&#x22;, &#x22;lv_math.h&#x22;, &#x22;lv_mem.h&#x22;, &#x22;lv_palette.h&#x22;, &#x22;lv_string.h&#x22;, &#x22;lv_tick.h&#x22;, &#x22;lv_timer.h&#x22;, &#x22;lv_types.h&#x22;]" />
