Page MenuHomeFreeBSD
Differential D15513

Rewrite USB device mode chapter
ClosedPublic
Actions

Authored by trasz on May 21 2018, 6:37 PM.
Tags
None
Referenced Files
Unknown Object (File)
Mon, Mar 24, 9:20 AM
Unknown Object (File)
Tue, Mar 11, 10:20 AM
Unknown Object (File)
Feb 8 2025, 3:45 AM
Unknown Object (File)
Jan 18 2025, 5:28 AM
Unknown Object (File)
Nov 24 2024, 10:56 PM
Unknown Object (File)
Nov 19 2024, 10:44 AM
Unknown Object (File)
Nov 19 2024, 10:22 AM
Unknown Object (File)
Oct 26 2024, 1:33 AM
View All 63 Files
Subscribers
bcr

Details

Reviewers
wblock
emaste
bcr
Commits
rD51744: Introduce a new chapter on USB Device Mode / USB OTG.

Diff Detail

Repository
rD FreeBSD doc repository - subversion
Lint
No Lint Coverage
Unit
No Test Coverage
Build Status
Buildable 16817
Build 16700: arc lint + arc unit

Event Timeline

trasz created this revision.May 21 2018, 6:37 PM
Harbormaster completed remote builds in B16741: Diff 42807.May 21 2018, 6:37 PM
trasz added reviewers: wblock, emaste.May 21 2018, 6:39 PM
bcr added a subscriber: bcr.May 22 2018, 5:02 PM

Thank you for updating the handbook chapter with your work on USB device mode. I added some things I've found. Mostly minor things, easy to fix.

en_US.ISO8859-1/books/handbook/usb-device-mode/chapter.xml
36

I would introduce the acronym OTG in parentheses here (right after "On the Go"), so that people that are reading on know what it stands for.

57

You don't need to break the line here prematurely (this is not a man page ;-)).

59

same here.

73

There must be an empty line here to separate the </para> from the new <para>.

122

s/the need special/the need for special/

124

Pull this line up into the one above.

146

The indentation seems off here. The <scree> needs to be on the same level as the <para>s above and below.

158

Make an empty line before <screen> appear here. ;-)

167

/as laptop/as a laptop/

169

the "pstat -t" would be better when wrapped in <command> tags. You can leave out the " then. Also, remove the "the" and "command" before and after it. You can rewrite it like this:

Use <command>pstat -t</command> on the host to list the terminal lines.

or

List terminal lines on the host using <command>pstat -t</command>

172

Another empty line here.

177

One more empty line at this position.

187

Another ... (you know what I mean). ;-)

197

And another...

202

s/as laptop/as a laptop/ (same as above)

203

s/open connection/open a connection/

204

s/Putty/<application>PuTTY</application>/

208

s/Putty/<application>PuTTY</application>/

209

Same here for Putty.

278

I think it would make sense to wrap the cfumass into <filename> tags here, as the sentence is referencing the file/script directly.

282

And another empty line...

288

Time for an empty line...

emaste added inline comments.May 22 2018, 5:23 PM
en_US.ISO8859-1/books/handbook/usb-device-mode/chapter.xml
35

use of?

45

maybe we should add something like "or a combination thereof"?

52

probably drop "the usual host mode". client port implies it's not host mode.

74–76

too many clauses in this sentence

trasz updated this revision to Diff 42942.May 24 2018, 5:49 PM

Fixes from bcr@ and emaste@.

Harbormaster completed remote builds in B16817: Diff 42942.May 24 2018, 5:49 PM
trasz added inline comments.May 24 2018, 5:50 PM
en_US.ISO8859-1/books/handbook/usb-device-mode/chapter.xml
74–76

You're probably right, but I'm not sure how to split it.

trasz updated this revision to Diff 42944.May 24 2018, 5:57 PM

Fix typo.

Harbormaster completed remote builds in B16819: Diff 42944.May 24 2018, 5:57 PM
bcr accepted this revision.May 29 2018, 2:02 PM

Looks good to me now, approved!

This revision is now accepted and ready to land.May 29 2018, 2:02 PM
Closed by commit rD51744: Introduce a new chapter on USB Device Mode / USB OTG. (authored by trasz). · Explain WhyMay 29 2018, 5:08 PM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathSize
en_US.ISO8859-1/
books/
handbook/
1 line
1 line
1 line
disks/
127 lines
374 lines

Diff 42942

View Options

en_US.ISO8859-1/books/handbook/Makefile

Show All 23 Lines
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE. .\" SUCH DAMAGE.
.\" .\"
.Dd August 15, 2016 .Dd June 5, 2024
fuzUnsubmitted
Not Done
Inline Actions

Should be adjust to today on commit.

fuz: Should be adjust to today on commit.
.Dt MEMCMP 3 .Dt MEMCMP 3
.Os .Os
.Sh NAME .Sh NAME
.Nm memcmp .Nm memcmp
.Nd compare byte string .Nd compare byte string
fuzUnsubmitted
Not Done
Inline Actions
.Nm memcmp
- .Nd compare byte string
+ .Nd compare byte object
.Sh LIBRARY
fuz:
.Sh LIBRARY .Sh LIBRARY
.Lb libc .Lb libc
.Sh SYNOPSIS .Sh SYNOPSIS
.In string.h .In string.h
.Ft int .Ft int
.Fn memcmp "const void *b1" "const void *b2" "size_t len" .Fn memcmp "const void *b1" "const void *b2" "size_t len"
.Sh DESCRIPTION .Sh DESCRIPTION
The The
.Fn memcmp .Fn memcmp
function function
compares byte string compares byte objdect
andrewUnsubmitted
Done
Inline Actions
function
- compares byte objdect
+ compares byte object
.Fa b1
andrew:
.Fa b1 .Fa b1
against byte string against byte object
.Fa b2 . .Fa b2 .
Both strings are assumed to be Both objects are assumed to be
.Fa len .Fa len
bytes long. bytes long.
.Sh RETURN VALUES .Sh RETURN VALUES
The The
.Fn memcmp .Fn memcmp
function function returns zero if the two objects are identical.
returns zero if the two strings are identical, Zero-length objects are considered identical.
otherwise returns the difference between the first two differing bytes The
(treated as .Fn memcmp
.Vt "unsigned char" function returns a negative value if the first differing byte has a lower
values, so that value in
.Sq Li \e200 .Fa b1
is greater than and a positive value if the first differing byte has a higher value in
.Sq Li \&\e0 , .Fa b1 .
emasteAuthorUnsubmitted
Done
Inline Actions
.Fn memcmp
- function returns if the two objects are identical.
+ function returns zero if the two objects are identical.
Zero-length objects are considered identical.
emaste:
fuzUnsubmitted
Not Done
Inline Actions
.Fn memcmp
function returns a negative value if the first differing byte has a lower
value in
.Fa b1
+ than in
+ .Fa b2
and a positive value if the first differing byte has a higher value in
- .Fa b1 .
+ .Fa b1
+ than in
+ .Fa b2 .
.Sh SEE ALSO
fuz:
for example).
Zero-length strings are always identical.
.Sh SEE ALSO .Sh SEE ALSO
.Xr bcmp 3 , .Xr bcmp 3 ,
.Xr strcasecmp 3 , .Xr strcasecmp 3 ,
.Xr strcmp 3 , .Xr strcmp 3 ,
.Xr strcoll 3 , .Xr strcoll 3 ,
.Xr strxfrm 3 , .Xr strxfrm 3 ,
.Xr timingsafe_memcmp 3 , .Xr timingsafe_memcmp 3 ,
.Xr wmemcmp 3 .Xr wmemcmp 3
.Sh STANDARDS .Sh STANDARDS
The The
.Fn memcmp .Fn memcmp
function function
conforms to conforms to
.St -isoC . .St -isoC .
View Options

en_US.ISO8859-1/books/handbook/book.xml

Show All 23 Lines
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE. .\" SUCH DAMAGE.
.\" .\"
.Dd August 15, 2016 .Dd June 5, 2024
fuzUnsubmitted
Not Done
Inline Actions

Should be adjust to today on commit.

fuz: Should be adjust to today on commit.
.Dt MEMCMP 3 .Dt MEMCMP 3
.Os .Os
.Sh NAME .Sh NAME
.Nm memcmp .Nm memcmp
.Nd compare byte string .Nd compare byte string
fuzUnsubmitted
Not Done
Inline Actions
.Nm memcmp
- .Nd compare byte string
+ .Nd compare byte object
.Sh LIBRARY
fuz:
.Sh LIBRARY .Sh LIBRARY
.Lb libc .Lb libc
.Sh SYNOPSIS .Sh SYNOPSIS
.In string.h .In string.h
.Ft int .Ft int
.Fn memcmp "const void *b1" "const void *b2" "size_t len" .Fn memcmp "const void *b1" "const void *b2" "size_t len"
.Sh DESCRIPTION .Sh DESCRIPTION
The The
.Fn memcmp .Fn memcmp
function function
compares byte string compares byte objdect
andrewUnsubmitted
Done
Inline Actions
function
- compares byte objdect
+ compares byte object
.Fa b1
andrew:
.Fa b1 .Fa b1
against byte string against byte object
.Fa b2 . .Fa b2 .
Both strings are assumed to be Both objects are assumed to be
.Fa len .Fa len
bytes long. bytes long.
.Sh RETURN VALUES .Sh RETURN VALUES
The The
.Fn memcmp .Fn memcmp
function function returns zero if the two objects are identical.
returns zero if the two strings are identical, Zero-length objects are considered identical.
otherwise returns the difference between the first two differing bytes The
(treated as .Fn memcmp
.Vt "unsigned char" function returns a negative value if the first differing byte has a lower
values, so that value in
.Sq Li \e200 .Fa b1
is greater than and a positive value if the first differing byte has a higher value in
.Sq Li \&\e0 , .Fa b1 .
emasteAuthorUnsubmitted
Done
Inline Actions
.Fn memcmp
- function returns if the two objects are identical.
+ function returns zero if the two objects are identical.
Zero-length objects are considered identical.
emaste:
fuzUnsubmitted
Not Done
Inline Actions
.Fn memcmp
function returns a negative value if the first differing byte has a lower
value in
.Fa b1
+ than in
+ .Fa b2
and a positive value if the first differing byte has a higher value in
- .Fa b1 .
+ .Fa b1
+ than in
+ .Fa b2 .
.Sh SEE ALSO
fuz:
for example).
Zero-length strings are always identical.
.Sh SEE ALSO .Sh SEE ALSO
.Xr bcmp 3 , .Xr bcmp 3 ,
.Xr strcasecmp 3 , .Xr strcasecmp 3 ,
.Xr strcmp 3 , .Xr strcmp 3 ,
.Xr strcoll 3 , .Xr strcoll 3 ,
.Xr strxfrm 3 , .Xr strxfrm 3 ,
.Xr timingsafe_memcmp 3 , .Xr timingsafe_memcmp 3 ,
.Xr wmemcmp 3 .Xr wmemcmp 3
.Sh STANDARDS .Sh STANDARDS
The The
.Fn memcmp .Fn memcmp
function function
conforms to conforms to
.St -isoC . .St -isoC .
View Options

en_US.ISO8859-1/books/handbook/chapters.ent

Show All 23 Lines
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE. .\" SUCH DAMAGE.
.\" .\"
.Dd August 15, 2016 .Dd June 5, 2024
fuzUnsubmitted
Not Done
Inline Actions

Should be adjust to today on commit.

fuz: Should be adjust to today on commit.
.Dt MEMCMP 3 .Dt MEMCMP 3
.Os .Os
.Sh NAME .Sh NAME
.Nm memcmp .Nm memcmp
.Nd compare byte string .Nd compare byte string
fuzUnsubmitted
Not Done
Inline Actions
.Nm memcmp
- .Nd compare byte string
+ .Nd compare byte object
.Sh LIBRARY
fuz:
.Sh LIBRARY .Sh LIBRARY
.Lb libc .Lb libc
.Sh SYNOPSIS .Sh SYNOPSIS
.In string.h .In string.h
.Ft int .Ft int
.Fn memcmp "const void *b1" "const void *b2" "size_t len" .Fn memcmp "const void *b1" "const void *b2" "size_t len"
.Sh DESCRIPTION .Sh DESCRIPTION
The The
.Fn memcmp .Fn memcmp
function function
compares byte string compares byte objdect
andrewUnsubmitted
Done
Inline Actions
function
- compares byte objdect
+ compares byte object
.Fa b1
andrew:
.Fa b1 .Fa b1
against byte string against byte object
.Fa b2 . .Fa b2 .
Both strings are assumed to be Both objects are assumed to be
.Fa len .Fa len
bytes long. bytes long.
.Sh RETURN VALUES .Sh RETURN VALUES
The The
.Fn memcmp .Fn memcmp
function function returns zero if the two objects are identical.
returns zero if the two strings are identical, Zero-length objects are considered identical.
otherwise returns the difference between the first two differing bytes The
(treated as .Fn memcmp
.Vt "unsigned char" function returns a negative value if the first differing byte has a lower
values, so that value in
.Sq Li \e200 .Fa b1
is greater than and a positive value if the first differing byte has a higher value in
.Sq Li \&\e0 , .Fa b1 .
emasteAuthorUnsubmitted
Done
Inline Actions
.Fn memcmp
- function returns if the two objects are identical.
+ function returns zero if the two objects are identical.
Zero-length objects are considered identical.
emaste:
fuzUnsubmitted
Not Done
Inline Actions
.Fn memcmp
function returns a negative value if the first differing byte has a lower
value in
.Fa b1
+ than in
+ .Fa b2
and a positive value if the first differing byte has a higher value in
- .Fa b1 .
+ .Fa b1
+ than in
+ .Fa b2 .
.Sh SEE ALSO
fuz:
for example).
Zero-length strings are always identical.
.Sh SEE ALSO .Sh SEE ALSO
.Xr bcmp 3 , .Xr bcmp 3 ,
.Xr strcasecmp 3 , .Xr strcasecmp 3 ,
.Xr strcmp 3 , .Xr strcmp 3 ,
.Xr strcoll 3 , .Xr strcoll 3 ,
.Xr strxfrm 3 , .Xr strxfrm 3 ,
.Xr timingsafe_memcmp 3 , .Xr timingsafe_memcmp 3 ,
.Xr wmemcmp 3 .Xr wmemcmp 3
.Sh STANDARDS .Sh STANDARDS
The The
.Fn memcmp .Fn memcmp
function function
conforms to conforms to
.St -isoC . .St -isoC .
View Options

en_US.ISO8859-1/books/handbook/disks/chapter.xml

Show All 23 Lines
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE. .\" SUCH DAMAGE.
.\" .\"
.Dd August 15, 2016 .Dd June 5, 2024
fuzUnsubmitted
Not Done
Inline Actions

Should be adjust to today on commit.

fuz: Should be adjust to today on commit.
.Dt MEMCMP 3 .Dt MEMCMP 3
.Os .Os
.Sh NAME .Sh NAME
.Nm memcmp .Nm memcmp
.Nd compare byte string .Nd compare byte string
fuzUnsubmitted
Not Done
Inline Actions
.Nm memcmp
- .Nd compare byte string
+ .Nd compare byte object
.Sh LIBRARY
fuz:
.Sh LIBRARY .Sh LIBRARY
.Lb libc .Lb libc
.Sh SYNOPSIS .Sh SYNOPSIS
.In string.h .In string.h
.Ft int .Ft int
.Fn memcmp "const void *b1" "const void *b2" "size_t len" .Fn memcmp "const void *b1" "const void *b2" "size_t len"
.Sh DESCRIPTION .Sh DESCRIPTION
The The
.Fn memcmp .Fn memcmp
function function
compares byte string compares byte objdect
andrewUnsubmitted
Done
Inline Actions
function
- compares byte objdect
+ compares byte object
.Fa b1
andrew:
.Fa b1 .Fa b1
against byte string against byte object
.Fa b2 . .Fa b2 .
Both strings are assumed to be Both objects are assumed to be
.Fa len .Fa len
bytes long. bytes long.
.Sh RETURN VALUES .Sh RETURN VALUES
The The
.Fn memcmp .Fn memcmp
function function returns zero if the two objects are identical.
returns zero if the two strings are identical, Zero-length objects are considered identical.
otherwise returns the difference between the first two differing bytes The
(treated as .Fn memcmp
.Vt "unsigned char" function returns a negative value if the first differing byte has a lower
values, so that value in
.Sq Li \e200 .Fa b1
is greater than and a positive value if the first differing byte has a higher value in
.Sq Li \&\e0 , .Fa b1 .
emasteAuthorUnsubmitted
Done
Inline Actions
.Fn memcmp
- function returns if the two objects are identical.
+ function returns zero if the two objects are identical.
Zero-length objects are considered identical.
emaste:
fuzUnsubmitted
Not Done
Inline Actions
.Fn memcmp
function returns a negative value if the first differing byte has a lower
value in
.Fa b1
+ than in
+ .Fa b2
and a positive value if the first differing byte has a higher value in
- .Fa b1 .
+ .Fa b1
+ than in
+ .Fa b2 .
.Sh SEE ALSO
fuz:
for example).
Zero-length strings are always identical.
.Sh SEE ALSO .Sh SEE ALSO
.Xr bcmp 3 , .Xr bcmp 3 ,
.Xr strcasecmp 3 , .Xr strcasecmp 3 ,
.Xr strcmp 3 , .Xr strcmp 3 ,
.Xr strcoll 3 , .Xr strcoll 3 ,
.Xr strxfrm 3 , .Xr strxfrm 3 ,
.Xr timingsafe_memcmp 3 , .Xr timingsafe_memcmp 3 ,
.Xr wmemcmp 3 .Xr wmemcmp 3
.Sh STANDARDS .Sh STANDARDS
The The
.Fn memcmp .Fn memcmp
function function
conforms to conforms to
.St -isoC . .St -isoC .
View Options

en_US.ISO8859-1/books/handbook/usb-device-mode/

Loading...
View Options

en_US.ISO8859-1/books/handbook/usb-device-mode/chapter.xml

Loading...