1
- .. _ usbc_device_stack :
1
+ .. _ usbc_api :
2
2
3
3
USB-C device stack
4
4
##################
@@ -36,7 +36,7 @@ For example, for the Sample USB-C Sink application:
36
36
Each Physical Type-C port is represented in the devicetree by a usb-c-connector
37
37
compatible node:
38
38
39
- .. literalinclude :: ../../../samples/subsys/usb_c/sink/boards/b_g474e_dpow1.overlay
39
+ .. literalinclude :: ../../../../ samples/subsys/usb_c/sink/boards/b_g474e_dpow1.overlay
40
40
:language: dts
41
41
:start-after: usbc.rst usbc-port start
42
42
:end-before: usbc.rst usbc-port end
@@ -45,7 +45,7 @@ compatible node:
45
45
VBUS is measured by a device that's referenced in the devicetree by a
46
46
usb-c-vbus-adc compatible node:
47
47
48
- .. literalinclude :: ../../../samples/subsys/usb_c/sink/boards/b_g474e_dpow1.overlay
48
+ .. literalinclude :: ../../../../ samples/subsys/usb_c/sink/boards/b_g474e_dpow1.overlay
49
49
:language: dts
50
50
:start-after: usbc.rst vbus-voltage-divider-adc start
51
51
:end-before: usbc.rst vbus-voltage-divider-adc end
@@ -55,55 +55,55 @@ usb-c-vbus-adc compatible node:
55
55
A user defined structure is defined and later registered with the subsystem and can
56
56
be accessed from callback through an API:
57
57
58
- .. literalinclude :: ../../../samples/subsys/usb_c/sink/src/main.c
58
+ .. literalinclude :: ../../../../ samples/subsys/usb_c/sink/src/main.c
59
59
:language: c
60
60
:start-after: usbc.rst port data object start
61
61
:end-before: usbc.rst port data object end
62
62
:linenos:
63
63
64
64
These callbacks are used by the subsystem to set or get application specific data:
65
65
66
- .. literalinclude :: ../../../samples/subsys/usb_c/sink/src/main.c
66
+ .. literalinclude :: ../../../../ samples/subsys/usb_c/sink/src/main.c
67
67
:language: c
68
68
:start-after: usbc.rst callbacks start
69
69
:end-before: usbc.rst callbacks end
70
70
:linenos:
71
71
72
72
This callback is used by the subsystem to query if a certain action can be taken:
73
73
74
- .. literalinclude :: ../../../samples/subsys/usb_c/sink/src/main.c
74
+ .. literalinclude :: ../../../../ samples/subsys/usb_c/sink/src/main.c
75
75
:language: c
76
76
:start-after: usbc.rst check start
77
77
:end-before: usbc.rst check end
78
78
:linenos:
79
79
80
80
This callback is used by the subsystem to notify the application of an event:
81
81
82
- .. literalinclude :: ../../../samples/subsys/usb_c/sink/src/main.c
82
+ .. literalinclude :: ../../../../ samples/subsys/usb_c/sink/src/main.c
83
83
:language: c
84
84
:start-after: usbc.rst notify start
85
85
:end-before: usbc.rst notify end
86
86
:linenos:
87
87
88
88
Registering the callbacks:
89
89
90
- .. literalinclude :: ../../../samples/subsys/usb_c/sink/src/main.c
90
+ .. literalinclude :: ../../../../ samples/subsys/usb_c/sink/src/main.c
91
91
:language: c
92
92
:start-after: usbc.rst register start
93
93
:end-before: usbc.rst register end
94
94
:linenos:
95
95
96
96
Register the user defined structure:
97
97
98
- .. literalinclude :: ../../../samples/subsys/usb_c/sink/src/main.c
98
+ .. literalinclude :: ../../../../ samples/subsys/usb_c/sink/src/main.c
99
99
:language: c
100
100
:start-after: usbc.rst user data start
101
101
:end-before: usbc.rst user data end
102
102
:linenos:
103
103
104
104
Start the USB-C subsystem:
105
105
106
- .. literalinclude :: ../../../samples/subsys/usb_c/sink/src/main.c
106
+ .. literalinclude :: ../../../../ samples/subsys/usb_c/sink/src/main.c
107
107
:language: c
108
108
:start-after: usbc.rst usbc start
109
109
:end-before: usbc.rst usbc end
@@ -126,7 +126,7 @@ For example, for the Sample USB-C Source application:
126
126
Each Physical Type-C port is represented in the devicetree by a ``usb-c-connector ``
127
127
compatible node:
128
128
129
- .. literalinclude :: ../../../samples/subsys/usb_c/source/boards/stm32g081b_eval.overlay
129
+ .. literalinclude :: ../../../../ samples/subsys/usb_c/source/boards/stm32g081b_eval.overlay
130
130
:language: dts
131
131
:start-after: usbc.rst usbc-port start
132
132
:end-before: usbc.rst usbc-port end
@@ -135,7 +135,7 @@ compatible node:
135
135
VBUS is measured by a device that's referenced in the devicetree by a
136
136
``usb-c-vbus-adc `` compatible node:
137
137
138
- .. literalinclude :: ../../../samples/subsys/usb_c/source/boards/stm32g081b_eval.overlay
138
+ .. literalinclude :: ../../../../ samples/subsys/usb_c/source/boards/stm32g081b_eval.overlay
139
139
:language: dts
140
140
:start-after: usbc.rst vbus-voltage-divider-adc start
141
141
:end-before: usbc.rst vbus-voltage-divider-adc end
@@ -145,55 +145,55 @@ VBUS is measured by a device that's referenced in the devicetree by a
145
145
A user defined structure is defined and later registered with the subsystem and can
146
146
be accessed from callback through an API:
147
147
148
- .. literalinclude :: ../../../samples/subsys/usb_c/source/src/main.c
148
+ .. literalinclude :: ../../../../ samples/subsys/usb_c/source/src/main.c
149
149
:language: c
150
150
:start-after: usbc.rst port data object start
151
151
:end-before: usbc.rst port data object end
152
152
:linenos:
153
153
154
154
These callbacks are used by the subsystem to set or get application specific data:
155
155
156
- .. literalinclude :: ../../../samples/subsys/usb_c/source/src/main.c
156
+ .. literalinclude :: ../../../../ samples/subsys/usb_c/source/src/main.c
157
157
:language: c
158
158
:start-after: usbc.rst callbacks start
159
159
:end-before: usbc.rst callbacks end
160
160
:linenos:
161
161
162
162
This callback is used by the subsystem to query if a certain action can be taken:
163
163
164
- .. literalinclude :: ../../../samples/subsys/usb_c/source/src/main.c
164
+ .. literalinclude :: ../../../../ samples/subsys/usb_c/source/src/main.c
165
165
:language: c
166
166
:start-after: usbc.rst check start
167
167
:end-before: usbc.rst check end
168
168
:linenos:
169
169
170
170
This callback is used by the subsystem to notify the application of an event:
171
171
172
- .. literalinclude :: ../../../samples/subsys/usb_c/source/src/main.c
172
+ .. literalinclude :: ../../../../ samples/subsys/usb_c/source/src/main.c
173
173
:language: c
174
174
:start-after: usbc.rst notify start
175
175
:end-before: usbc.rst notify end
176
176
:linenos:
177
177
178
178
Registering the callbacks:
179
179
180
- .. literalinclude :: ../../../samples/subsys/usb_c/source/src/main.c
180
+ .. literalinclude :: ../../../../ samples/subsys/usb_c/source/src/main.c
181
181
:language: c
182
182
:start-after: usbc.rst register start
183
183
:end-before: usbc.rst register end
184
184
:linenos:
185
185
186
186
Register the user defined structure:
187
187
188
- .. literalinclude :: ../../../samples/subsys/usb_c/source/src/main.c
188
+ .. literalinclude :: ../../../../ samples/subsys/usb_c/source/src/main.c
189
189
:language: c
190
190
:start-after: usbc.rst user data start
191
191
:end-before: usbc.rst user data end
192
192
:linenos:
193
193
194
194
Start the USB-C subsystem:
195
195
196
- .. literalinclude :: ../../../samples/subsys/usb_c/source/src/main.c
196
+ .. literalinclude :: ../../../../ samples/subsys/usb_c/source/src/main.c
197
197
:language: c
198
198
:start-after: usbc.rst usbc start
199
199
:end-before: usbc.rst usbc end
0 commit comments