vendor-ibm-astlpc.md: Remove extra trailing spaces

Signed-off-by: George Liu <liuxiwei@ieisystem.com>
Change-Id: Ibe64b5c1974b332f456683679900c94bab25e1a3

vendor-ibm-astlpc.md: Fix MD036 warnings

The following warnings are generated by using markdownlint analysis:
```
docs/bindings/vendor-ibm-astlpc.md:26 MD036/no-emphasis-as-heading Emphasis used ins

vendor-ibm-astlpc.md: Fix MD036 warnings

The following warnings are generated by using markdownlint analysis:
```
docs/bindings/vendor-ibm-astlpc.md:26 MD036/no-emphasis-as-heading Emphasis used instead of a heading [Context: "BTU: Baseline Transmission Uni..."]
docs/bindings/vendor-ibm-astlpc.md:31 MD036/no-emphasis-as-heading Emphasis used instead of a heading [Context: "IBF: Input Buffer Full"]
docs/bindings/vendor-ibm-astlpc.md:37 MD036/no-emphasis-as-heading Emphasis used instead of a heading [Context: "IDR: Input Data Register"]
docs/bindings/vendor-ibm-astlpc.md:42 MD036/no-emphasis-as-heading Emphasis used instead of a heading [Context: "KCS: Keyboard-Controller-Style"]
docs/bindings/vendor-ibm-astlpc.md:52 MD036/no-emphasis-as-heading Emphasis used instead of a heading [Context: "LPC Bus: Low Pin Count Bus"]
docs/bindings/vendor-ibm-astlpc.md:57 MD036/no-emphasis-as-heading Emphasis used instead of a heading [Context: "LPC FW: LPC Firmware Cycles"]
docs/bindings/vendor-ibm-astlpc.md:64 MD036/no-emphasis-as-heading Emphasis used instead of a heading [Context: "MTU: Maximum Transmission Unit"]
docs/bindings/vendor-ibm-astlpc.md:70 MD036/no-emphasis-as-heading Emphasis used instead of a heading [Context: "OBF: Output Buffer Full"]
docs/bindings/vendor-ibm-astlpc.md:76 MD036/no-emphasis-as-heading Emphasis used instead of a heading [Context: "ODR: Output Data Register"]
docs/bindings/vendor-ibm-astlpc.md:81 MD036/no-emphasis-as-heading Emphasis used instead of a heading [Context: "STR: Status Register"]
```
Refer to markdown-lint [1] to fix MD036
[1]: https://github.com/updownpress/markdown-lint/blob/master/rules/036-no-emphasis-as-header.md

Signed-off-by: George Liu <liuxiwei@ieisystem.com>
Change-Id: Id56964b7edff73c060215d27b55e558304b83269

show more ...

vendor-ibm-astlpc.md: Fix MD034 warnings

The following warnings are generated by using markdownlint analysis:
```
docs/bindings/vendor-ibm-astlpc.md:15:4 MD034/no-bare-urls Bare URL used [Context: "

vendor-ibm-astlpc.md: Fix MD034 warnings

The following warnings are generated by using markdownlint analysis:
```
docs/bindings/vendor-ibm-astlpc.md:15:4 MD034/no-bare-urls Bare URL used [Context: "http://www.dmtf.org/standards/..."]
docs/bindings/vendor-ibm-astlpc.md:18:4 MD034/no-bare-urls Bare URL used [Context: "https://www.intel.com/content/..."]
docs/bindings/vendor-ibm-astlpc.md:22:4 MD034/no-bare-urls Bare URL used [Context: "http://download.intel.com/desi..."]
```
Refer to markdown-lint [1] to fix MD034
[1]: https://github.com/updownpress/markdown-lint/blob/master/rules/034-no-bare-urls.md

Signed-off-by: George Liu <liuxiwei@ieisystem.com>
Change-Id: I6a25ee9610678378e50ff5d2d6c953f1084d80ae

show more ...

prettier: re-format

Prettier is enabled in openbmc-build-scripts on Markdown, JSON, and YAML
files to have consistent formatting for these file types. Re-run the
formatter on the whole repository.

prettier: re-format

Prettier is enabled in openbmc-build-scripts on Markdown, JSON, and YAML
files to have consistent formatting for these file types. Re-run the
formatter on the whole repository.

Change-Id: Ibcba1d4dcfc062988d71ea12912b53512fa644ff
Signed-off-by: Patrick Williams <patrick@stwcx.xyz>

show more ...

docs: bindings: Add a Makefile

Makes local preview of changes easier to manage.

Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
Change-Id: I67be4b51664c1b31ab183d2e2f9c63faaf34b919

docs: vendor-ibm-astlpc: Define v3 of the protocol

v3 adds a CRC-32 integrity check across each packet exchanged via the
binding.

Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
Change-Id: Ie9b798e

docs: vendor-ibm-astlpc: Define v3 of the protocol

v3 adds a CRC-32 integrity check across each packet exchanged via the
binding.

Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
Change-Id: Ie9b798e1076e099525ebf7bcfe5d8ea81367ae3a

show more ...

docs: vendor-ibm-astlpc: Tweak description of header magic

Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
Change-Id: Ied2a9d85c63d44bb227385f3ab981b44e8498d80

docs: vendor-ibm-astlpc: Style code snippets as C

Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
Change-Id: I95a31775cef4f54e37a94cde5185493d3427f586

docs: vendor-ibm-astlpc: Fix IDs in packet transmission sequences

Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
Change-Id: I974a1c72c57f899d297e7cb71e4dbec5ca325ea4

docs: vendor-ibm-astlpc: Increase prominence of endianness

Describe this before we get distracted by other details of the LPC FW
window.

Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
Change-Id: I

docs: vendor-ibm-astlpc: Increase prominence of endianness

Describe this before we get distracted by other details of the LPC FW
window.

Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
Change-Id: Ibe2c17cdc60631a4402fd182be64d636c6835605

show more ...

docs: vendor-ibm-astlpc: Annotate {M,L}SB in Bit column

Tidy up alignment of the descriptions.

Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
Change-Id: Ie15ef81ed337bf183e6367e0f92547aa5bc2fd1a

docs: vendor-ibm-astlpc: Fix packet exchange order of operations

We read data from the KCS channels to confirm the command type before
reading the packet data from the FW window.

Signed-off-by: And

docs: vendor-ibm-astlpc: Fix packet exchange order of operations

We read data from the KCS channels to confirm the command type before
reading the packet data from the FW window.

Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
Change-Id: I19378b20c91183b5403f046cb7ab22d83c257e40

show more ...

docs: vendor-ibm-astlpc: Add definitions for KCS registers

These were explained in the document body but deserve their own
definitions given their importance to the protocol.

Signed-off-by: Andrew

docs: vendor-ibm-astlpc: Add definitions for KCS registers

These were explained in the document body but deserve their own
definitions given their importance to the protocol.

Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
Change-Id: I2cdf60dda74efba95e6e78bd4a53aa9558308d75

show more ...

docs: vendor-ibm-astlpc: Use numbered list for strictly ordered ops

I'm not sure how we used a bullet list for a section titled "the
following sequence occurs".

Signed-off-by: Andrew Jeffery <andre

docs: vendor-ibm-astlpc: Use numbered list for strictly ordered ops

I'm not sure how we used a bullet list for a section titled "the
following sequence occurs".

Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
Change-Id: I28dbe579de62a77726c617dd7aad11239a23f2ff

show more ...

docs: vendor-ibm-astlpc: Reorder sections to improve flow

The new order tries to keep the concepts flowing from least-to-most
detailed.

Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
Change-Id: Ib

docs: vendor-ibm-astlpc: Reorder sections to improve flow

The new order tries to keep the concepts flowing from least-to-most
detailed.

Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
Change-Id: Ib076c78f79aaedcb4b6c5c0e2606f8c2cbdd17a9

show more ...

docs: vendor-ibm-astlpc: Reduce emphasis for definitions

The aim is to be eye-catching but not over-bearing.

Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
Change-Id: I4cde5f858ab6e26754c8b9d48df3

docs: vendor-ibm-astlpc: Reduce emphasis for definitions

The aim is to be eye-catching but not over-bearing.

Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
Change-Id: I4cde5f858ab6e26754c8b9d48df3a96b07bd4545

show more ...

docs: vendor-ibm-astlpc: References as a numbered list

Make it easier to distinguish what text is which document at a glance.

Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
Change-Id: Ifdd69d9e3af

docs: vendor-ibm-astlpc: References as a numbered list

Make it easier to distinguish what text is which document at a glance.

Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
Change-Id: Ifdd69d9e3af3706c044e374984337609f9d70dde

show more ...

docs: vendor-ibm-astlpc: Improve readability with explicit line breaks

Separate the reference document URLs from the document names.

Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
Change-Id: I0f7e

docs: vendor-ibm-astlpc: Improve readability with explicit line breaks

Separate the reference document URLs from the document names.

Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
Change-Id: I0f7eff977f01c67f2757814ede81da07f7cbba43

show more ...

docs: vendor-ibm-astlpc: Remove intimidating header wording

Given the state of the rest of the document, stop trying to be super
formal.

Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
Change-Id: I

docs: vendor-ibm-astlpc: Remove intimidating header wording

Given the state of the rest of the document, stop trying to be super
formal.

Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
Change-Id: Ibdff4bdbc927cfcb77a691344748ac384c039641

show more ...

docs: Rename astlpc binding to include vendor

It helps to identify who is driving development of the binding.

Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
Change-Id: Ifb4508701e2a511632ba50dcee0

docs: Rename astlpc binding to include vendor

It helps to identify who is driving development of the binding.

Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
Change-Id: Ifb4508701e2a511632ba50dcee027dc01a247fa4

show more ...

docs: astlpc: Document the behaviours of protocol version 2

The sole feature of version 2 is maximum transmission unit negotiation.
The process is designed in a backwards-compatible fashion with ver

docs: astlpc: Document the behaviours of protocol version 2

The sole feature of version 2 is maximum transmission unit negotiation.
The process is designed in a backwards-compatible fashion with version
1. The negotiated version must be at least 2 in order to exploit MTUs
larger than the baseline transmission unit.

Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
Change-Id: Ife23e0551f975894fbb0544b4b1d3cf0b4190b4f

show more ...

docs: astlpc: Factor out KCS command and status sequences

Dedicate words to the mechanics of setting status and sending commands
via the KCS interface. Factor out these behaviours from the binding
i

docs: astlpc: Factor out KCS command and status sequences

Dedicate words to the mechanics of setting status and sending commands
via the KCS interface. Factor out these behaviours from the binding
initialisation and packet transmission sequences to keep them succinct.

Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
Change-Id: I1316045d6bb6f3a980a83ed2b046d7e68cabbf01

show more ...

docs: astlpc: Describe some implementation details

However, isolate the details to their own section near the end of the
document so as not to disrupt specification of the binding behaviour.

Signed

docs: astlpc: Describe some implementation details

However, isolate the details to their own section near the end of the
document so as not to disrupt specification of the binding behaviour.

Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
Change-Id: I7d4ab48b5659caa185a3f665857daee50dfb5a61

show more ...

docs: astlpc: Introduce scope, terms and reference sections

Link to supporting documentation and provide definitions for the various
terms used through the document.

Signed-off-by: Andrew Jeffery <

docs: astlpc: Introduce scope, terms and reference sections

Link to supporting documentation and provide definitions for the various
terms used through the document.

Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
Change-Id: Id27dcda9720ca4717e395a83bcf1091f2e8416d2

show more ...

docs: Describe operation of the astlpc binding

This is a mostly-faithful reproduction of the internal document that has
so-far driven development of the binding inside IBM. It covers the
behaviour o

docs: Describe operation of the astlpc binding

This is a mostly-faithful reproduction of the internal document that has
so-far driven development of the binding inside IBM. It covers the
behaviour of the protocol along with constraints motivating its
development. The binding was developed for use on POWER host
architecture systems, which are LPC-based.

Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
Change-Id: I6708ed5776419ab03b2f569cb243b5e3df21885b

show more ...