Skip to content

Conversation

@jonaswood01
Copy link
Contributor

In response to the Linux Kernel GPIO in the SDK Docs feeling insufficient. So, this update walks someone through a quick example for using GPIO in user space and provides resources for command-line tools and additional guides.

@github-actions
Copy link

github-actions bot commented Apr 1, 2025

New warnings found with rstcheck:

source/linux/Foundational_Components/Kernel/Kernel_Drivers/GPIO.rst:6: (INFO/1) Enumerated list start value not ordinal-1: "2" (ordinal 2)
source/linux/Foundational_Components/Kernel/Kernel_Drivers/GPIO.rst:6: (INFO/1) Enumerated list start value not ordinal-1: "3" (ordinal 3)
source/linux/Foundational_Components/Kernel/Kernel_Drivers/GPIO.rst:6: (INFO/1) Enumerated list start value not ordinal-1: "4" (ordinal 4)
source/linux/Foundational_Components/Kernel/Kernel_Drivers/GPIO.rst:6: (INFO/1) Enumerated list start value not ordinal-1: "5" (ordinal 5)
source/linux/Foundational_Components/Kernel/Kernel_Drivers/GPIO.rst:6: (INFO/1) Enumerated list start value not ordinal-1: "6" (ordinal 6)

@praneethbajjuri
Copy link
Collaborator

@DhruvaG2000 for review

@praneethbajjuri
Copy link
Collaborator

@jonaswood01 thanks for sending this PR. Review the checker failures. https://github.com/TexasInstruments/processor-sdk-doc/pull/234/checks

@github-actions
Copy link

github-actions bot commented Apr 1, 2025

New warnings found with rstcheck:

source/linux/Foundational_Components/Kernel/Kernel_Drivers/GPIO.rst:4: (INFO/1) Enumerated list start value not ordinal-1: "2" (ordinal 2)
source/linux/Foundational_Components/Kernel/Kernel_Drivers/GPIO.rst:4: (INFO/1) Enumerated list start value not ordinal-1: "3" (ordinal 3)
source/linux/Foundational_Components/Kernel/Kernel_Drivers/GPIO.rst:4: (INFO/1) Enumerated list start value not ordinal-1: "4" (ordinal 4)
source/linux/Foundational_Components/Kernel/Kernel_Drivers/GPIO.rst:4: (INFO/1) Enumerated list start value not ordinal-1: "5" (ordinal 5)
source/linux/Foundational_Components/Kernel/Kernel_Drivers/GPIO.rst:4: (INFO/1) Enumerated list start value not ordinal-1: "6" (ordinal 6)

@github-actions
Copy link

github-actions bot commented Apr 1, 2025

New warnings found with rstcheck:

source/linux/Foundational_Components/Kernel/Kernel_Drivers/GPIO.rst:4: (INFO/1) Enumerated list start value not ordinal-1: "2" (ordinal 2)
source/linux/Foundational_Components/Kernel/Kernel_Drivers/GPIO.rst:4: (INFO/1) Enumerated list start value not ordinal-1: "3" (ordinal 3)
source/linux/Foundational_Components/Kernel/Kernel_Drivers/GPIO.rst:4: (INFO/1) Enumerated list start value not ordinal-1: "4" (ordinal 4)
source/linux/Foundational_Components/Kernel/Kernel_Drivers/GPIO.rst:4: (INFO/1) Enumerated list start value not ordinal-1: "5" (ordinal 5)
source/linux/Foundational_Components/Kernel/Kernel_Drivers/GPIO.rst:4: (INFO/1) Enumerated list start value not ordinal-1: "6" (ordinal 6)

Copy link

@madweshanshu madweshanshu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! I think the man page links should refer to the source rather than the Debian page.

Thank you for linking the GPIO E2E FAQs :)

Copy link
Collaborator

@makohoek makohoek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @jonaswood01,

Thank you for the patch. Looking at the authorship, it seems you are not the author of this patch:

commit 1eb41f7a21f9bb2034c74252f885a71e2ec27cec (jonaswood01/master, jonaswood01/HEAD)
Author: Maxime Fournier <[email protected]>
Date:   Tue Apr 1 16:52:17 2025 +0200

    docs(GPIO): Updated Kernel driver doc with examples
    
    Replaced Debian links with lgpiod links and cleaned a lengthy URL.
    
    Signed-off-by: Jonas Wood <[email protected]>

Can you please fix this? It seems weird that Maxime is the author here since you are the one submitting the pull request.
This can be fixed with:

$ git commit --amend --reset-author

Also, can you rebase this, please? It seems that this commit modifies some Android files (such as source/android/Foundational_Components_Bootloaders.rst) which seem unrelated to this change.

See: https://docs.github.com/en/get-started/using-git/about-git-rebase for help with git rebase

@jonaswood01
Copy link
Contributor Author

jonaswood01 commented Apr 2, 2025

Hi @jonaswood01,
Thank you for the patch. Looking at the authorship, it seems you are not the author of this patch:

commit 1eb41f7a21f9bb2034c74252f885a71e2ec27cec (jonaswood01/master, jonaswood01/HEAD)
Author: Maxime Fournier <[email protected]>
Date:   Tue Apr 1 16:52:17 2025 +0200

    docs(GPIO): Updated Kernel driver doc with examples
    
    Replaced Debian links with lgpiod links and cleaned a lengthy URL.
    
    Signed-off-by: Jonas Wood <[email protected]>

Can you please fix this? It seems weird that Maxime is the author here since you are the one submitting the pull request. This can be fixed with:

$ git commit --amend --reset-author

Also, can you rebase this, please? It seems that this commit modifies some Android files (such as source/android/Foundational_Components_Bootloaders.rst) which seem unrelated to this change.
See: https://docs.github.com/en/get-started/using-git/about-git-rebase for help with git rebase

Not sure what happened exactly, seems that a git pull had included Maxime Fournier's patch in mine unintentionally. But the authorship of this patch (me) should be fixed now, and the Android files (and Maxime's patch) you mentioned are removed from this patch and pull request.

Updates Linux Kernel GPIO doc with user space examples
and resources. Adjusts formatting.

Signed-off-by: Jonas Wood <[email protected]>
Copy link
Collaborator

@makohoek makohoek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I mostly review Android related things (which are no longer present in this commit).

I confirm that:

  • commit authorship looks good
  • there are no longer any (unrelated) Android changes in this PR.

I have not thouroughly reviewed anything else, but approving anyways.

@jonaswood01 jonaswood01 requested review from cshilwant and jmenti April 3, 2025 14:25
@praneethbajjuri praneethbajjuri merged commit 1a6b96e into TexasInstruments:master Apr 3, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.