Add design docs #50
Add design docs #50
Conversation
documentation/design.md
Outdated
| A primer on the hardware with which this project interfaces should be useful in | ||
| understanding the design choices made. |
There was a problem hiding this comment.
| A primer on the hardware with which this project interfaces should be useful in | |
| understanding the design choices made. | |
| A primer on the hardware that this project interfaces with should be helpful in understanding the design choices made. |
There was a problem hiding this comment.
I'd prefer not to end the sentence with a preposition
documentation/design.md
Outdated
|
|
||
| #### Addressing oddity | ||
|
|
||
| Accessing the registers in `BAR4` requires manipulation of their addresses, |
There was a problem hiding this comment.
| Accessing the registers in `BAR4` requires manipulation of their addresses, | |
| Accessing the registers in `BAR4` requires manipulation of their addresses |
There was a problem hiding this comment.
It seems a bit awkward to me because the second clause is tightly connected to the first. I don't think that it's grammatically incorrect, though.
documentation/design.md
Outdated
| implementation detail) using the functions defined in `util/pcie.h`. | ||
|
|
||
| `BAR2` can also be accessed when `struct pcie_bars` points to a serial port, | ||
| which is used when debugging boards outside of a MTCA crate. |
There was a problem hiding this comment.
| which is used when debugging boards outside of a MTCA crate. | |
| which is used when debugging boards outside of a µTCA crate. |
or
| which is used when debugging boards outside of a MTCA crate. | |
| which is used when debugging boards outside of a uTCA crate. |
There was a problem hiding this comment.
The workshop seems to prefer MTCA. Do you have a reason for preferring the u version?
There was a problem hiding this comment.
The PICMG page also has some instances of MTCA D:
The reason I'm mostly using MTCA nowadays is because it's easier to type, and I don't like pretending "uTCA" is "µTCA".
@augustofg do you have any preference?
The interface provided by the gateware was what guided the library design, so we should document that first.
No description provided.