Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Suggestion for edits to the GPIO pinning document to prevent confusion #486

Open
gvkt opened this issue Dec 7, 2021 · 1 comment
Open

Comments

@gvkt
Copy link

gvkt commented Dec 7, 2021

In the document
https://github.com/VoodooI2C/VoodooI2C/blob/master/Documentation/GPIO%20Pinning.md

The last line of the paragraph

Consult the list found here (Sunrise Point, Cannon Point-LP, Cannon Point-H, Ice Lake). Look up your device's hexadecimal APIC pin number in the right hand column. The corresponding label on the left hand side is of the form GPP_XYY_IRQ - take a note of this label. Now consult the second list found here (Sunrise Point, Cannon Point-LP, Cannon Point-H, Ice Lake). Look up the label you took a note of in the list (note that 'IRQ' is no longer in the label name, this doesn't matter). The corresponding number on the right is your decimal GPIO pin number.

Should be clarified to something like

is your decimal hardware pin number for all chipsets. This is the same as the decimal GPIO number in older chipsets and can be used for the pin specified for the driver but in newer chipsets, the GPIO pin number can be different from the hardware number. Therefore we need to...

Otherwise, for the non-experts it is not clear whether you have found the hardware number or the GPIO pin number and the next paragraph is extremely confusing as to why it is referring to your found hardware pin and computing the GPIO pin that you found in previous paragraph.

Also, it might be useful to clarify that the the SBFG method should return the GPIO pin number and that the Voodoo kext computes the hardware pin number from it and therefore the lookups from the community table for newer chipsets is doing the reverse computation.

@kprinssu
Copy link
Collaborator

@gvkt Would you please create a PR for this? Documentation changes are easy and straightforward to review and merge :)

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

No branches or pull requests

2 participants