Fix ao-bitbang examples to not have . in the first column
[fw/altos] / ao-tools / ao-bitbang / ao-bitbang.1
1 .\"
2 .\" Copyright © 2009 Keith Packard <keithp@keithp.com>
3 .\"
4 .\" This program is free software; you can redistribute it and/or modify
5 .\" it under the terms of the GNU General Public License as published by
6 .\" the Free Software Foundation; either version 2 of the License, or
7 .\" (at your option) any later version.
8 .\"
9 .\" This program is distributed in the hope that it will be useful, but
10 .\" WITHOUT ANY WARRANTY; without even the implied warranty of
11 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12 .\" General Public License for more details.
13 .\"
14 .\" You should have received a copy of the GNU General Public License along
15 .\" with this program; if not, write to the Free Software Foundation, Inc.,
16 .\" 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
17 .\"
18 .\"
19 .TH AO-BITBANG 1 "ao-bitbang" ""
20 .SH NAME
21 ao-bitbang \- Low-level cc1111 interface diagnostic tool
22 .SH SYNOPSIS
23 .B "ao-bitbang"
24 .SH DESCRIPTION
25 .I ao-bitbang
26 connects through a CP2103 usb-to-serial converter and uses the GPIO
27 pins to communicate with the debug port on a cc1111 device. It
28 provides raw access to the debug pins to help debug the lowest level
29 communication path.
30 .SH USAGE
31 .I ao-bitbang
32 reads a sequence of bit manipulations from stdin, sends them to the
33 device and reports status on stdout.
34 .P
35 Each line on stdin should contain a single letter command for each of
36 the three debug lines on the cc1111 -- clock, data and reset. Each bit
37 can be in one of three states -- on (C, D or R), off (.) or tri-state
38 (-) for input. Empty lines, or lines starting with '#' are
39 ignored. Anything beyond the last bit in a line is also ignored. The
40 bits must be listed in the correct order, and the 'on' values must
41 match the desired bit.
42 .SH EXAMPLE
43 .IP "Reset the target device"
44 .nf
45  # reset
46  C D R
47  C D R
48  C D R
49  C D R
50 .fi
51 .IP "Get Chip ID"
52 .nf
53  #
54  # Debug mode - drive RESET_N low for two clock cycles
55  #
56  C D R
57  . D .
58  C D .
59  . D .
60  C D .
61  . D R
62
63  #
64  # GET_CHIP_ID
65
66  C . R  0
67  . . R
68  C D R  1
69  . D R
70  C D R  1
71  . D R
72  C . R  0
73  . . R
74
75  C D R  1
76  . D R
77  C . R  0
78  . . R
79  C . R  0
80  . . R
81  C . R  0
82  . . R
83
84  #
85  # start reading again
86  #
87
88  C D R
89  . - R
90  C - R
91  . - R
92  C - R
93  . - R
94  C - R
95  . - R
96
97  C - R
98  . - R
99  C - R
100  . - R
101  C - R
102  . - R
103  C - R
104  . - R
105
106  C - R
107  . - R
108  C - R
109  . - R
110  C - R
111  . - R
112  C - R
113  . - R
114
115  C - R
116  . - R
117  C - R
118  . - R
119  C - R
120  . - R
121  C - R
122  . - R
123
124  C D R
125 .fi
126 .SH AUTHOR
127 Keith Packard