Skip to content

Conversation

bruno-f-cruz
Copy link
Member

@bruno-f-cruz bruno-f-cruz commented Jun 24, 2025

  • Wording improvements, missing descriptions and notice for optional registers
  • Reorganize document sections to reduce nesting and improve readability
  • Add notes on optional registers and defaults
  • Remove duplicated operation mode definitions
  • Add backlinks to operation mode section
  • Adopt requirement key words from RFC 2119
  • Add links to individual register specs
  • Move deprecated registers to separate section
  • Remove speed mode from overview to emphasize deprecation
  • Add device interface conceptual background

Preview: Device.md

@bruno-f-cruz bruno-f-cruz changed the title Version register with optional Add explicit clarification regarding default behavior Jun 24, 2025
@bruno-f-cruz bruno-f-cruz changed the title Add explicit clarification regarding default behavior Add explicit clarification regarding default register behavior Jun 24, 2025
@glopesdev glopesdev force-pushed the version-register-with-optional branch from 31b6513 to 774b83e Compare June 25, 2025 12:18
@glopesdev glopesdev force-pushed the version-register-with-optional branch 9 times, most recently from e49f4ca to 755beea Compare June 28, 2025 20:47
@glopesdev glopesdev marked this pull request as ready for review June 28, 2025 20:48
@glopesdev glopesdev requested a review from a team June 28, 2025 20:56
@glopesdev glopesdev added the documentation Improvements or additions to documentation label Jun 28, 2025
@glopesdev glopesdev changed the title Add explicit clarification regarding default register behavior Improved specification of device registers and operation Jun 28, 2025
Base automatically changed from version-register to main July 3, 2025 20:50
@glopesdev glopesdev force-pushed the version-register-with-optional branch from 1ee4461 to 1666a19 Compare July 3, 2025 20:57
glopesdev and others added 16 commits July 3, 2025 21:58
Cross reference links were also added to alternative registers to be
used, whenever possible.
This is to emphasize we do not expect any further support.
Introduce definition of a device interface, and register. The sections
are also reorganized and renamed for clarity.
Co-authored-by: glopesdev <g.lopes@neurogears.org>
Co-authored-by: glopesdev <g.lopes@neurogears.org>
Co-authored-by: glopesdev <g.lopes@neurogears.org>
Co-authored-by: glopesdev <g.lopes@neurogears.org>
@glopesdev glopesdev force-pushed the version-register-with-optional branch from 1666a19 to dac194d Compare July 3, 2025 20:58
@glopesdev glopesdev merged commit 09440f3 into main Jul 3, 2025
1 check passed
@glopesdev glopesdev deleted the version-register-with-optional branch July 3, 2025 21:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants