Skip to content

Commit 1d8f62d

Browse files
author
Kelvin Cao
committed
Minor updates to the char device part of README
1) Add use of term 'Command ID' 2) Add use of term 'Command Return Value' 3) Add a missing ')'
1 parent 54716b4 commit 1d8f62d

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ The primary means of communicating with the Switchtec management firmware is
2323
through the Memory-mapped Remote Procedure Call (MRPC) interface.
2424
Commands are submitted to the interface with a 4-byte command
2525
identifier and up to 1KB of command specific data. The firmware will
26-
respond with a 4 bytes return code and up to 1KB of command specific
26+
respond with a 4-byte return code and up to 1KB of command specific
2727
data. The interface only processes a single command at a time.
2828

2929

@@ -36,18 +36,18 @@ device: /dev/switchtec#, one for each management endpoint in the system.
3636
The char device has the following semantics:
3737

3838
* A write must consist of at least 4 bytes and no more than 1028 bytes.
39-
The first four bytes will be interpreted as the command to run and
40-
the remainder will be used as the input data. A write will send the
39+
The first 4 bytes will be interpreted as the Command ID and the
40+
remainder will be used as the input data. A write will send the
4141
command to the firmware to begin processing.
4242

4343
* Each write must be followed by exactly one read. Any double write will
4444
produce an error and any read that doesn't follow a write will
4545
produce an error.
4646

4747
* A read will block until the firmware completes the command and return
48-
the four bytes of status plus up to 1024 bytes of output data. (The
49-
length will be specified by the size parameter of the read call --
50-
reading less than 4 bytes will produce an error.
48+
the 4-byte Command Return Value plus up to 1024 bytes of output
49+
data. (The length will be specified by the size parameter of the read
50+
call -- reading less than 4 bytes will produce an error.)
5151

5252
* The poll call will also be supported for userspace applications that
5353
need to do other things while waiting for the command to complete.

0 commit comments

Comments
 (0)