Skip to content

ahci.4: make HARDWARE section more conformant #1662

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

kenrap
Copy link

@kenrap kenrap commented Apr 14, 2025

@concussious

Also, I'm not sure how to conform the next paragraph about nvme(4).

@kenrap kenrap force-pushed the ahci-hardware-conform branch from ed37c14 to d6094f1 Compare April 14, 2025 04:17
@concussious
Copy link
Contributor

This is kind of a hard one, and it's pretty fine the way it is. I'm not really sure how to improve it, rather.

A good choice would be like, whatever starts with "The currently supported ATA/SATA controller chips are:" below it, because we have no idea. Many drivers need just the first sentence fixed so it's clear in the HW Relnotes what's going on there.

Some others:

  • uipaq has all its information in the HW Relnotes, those need to be removed and put in a hardware section in the manual
  • Same with puc

@kenrap
Copy link
Author

kenrap commented Apr 14, 2025

  • uipaq has all its information in the HW Relnotes, those need to be removed and put in a hardware section in the manual

It seems that uipaq(4) already had all the items from the release notes in its HARDWARE section. But in the release notes, it's not properly formatted with asterisk bullets.

@concussious
Copy link
Contributor

concussious commented Apr 14, 2025

Oh I missed it because it's sorted wrong.

Edit: Hmmm. That might actually be a better way to sort it?

@kenrap
Copy link
Author

kenrap commented Apr 14, 2025

I'm going to make a puc(4) PR soon that adds a HARDWARE section for it.

Comment on lines +154 to +158
.It Type: Ta Code:
.It Mass Storage Ta PCI Class 0x01
.It SATA Ta Subclass 0x06
.It AHCI Ta Programming Interface 0x01
.It Legacy-PATA + AHCI-SATA via ata(4) Ta Programming Interface 0x01
Copy link
Member

Choose a reason for hiding this comment

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

This is not a list of compatible controllers. Those are requisites that must be met same time for the driver to attach.

Copy link
Contributor

@concussious concussious Apr 14, 2025

Choose a reason for hiding this comment

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

Yeah, as I said above I don't think we can really improve this one from what is currently in the tree.

@kenrap
Copy link
Author

kenrap commented Apr 16, 2025

Should I close this or would there be value into keeping this open?

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.

3 participants