aboutsummaryrefslogtreecommitdiffstats
path: root/usbh/src/pipe/status_pipe.rs
blob: be135c5031cfbfd46abc18018712cc4d6dae5c91 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
/// Host Status Pipe.
///
/// Offset: 0x0e & 0x1e
/// Reset: 0xxxxxx
/// Property: PAC Write-Protection, Write-Synchronized, Read-Synchronized
#[derive(Clone, Copy, Debug)]
#[repr(C, packed)]
pub(crate) struct StatusPipe(u8);

pub(crate) struct R {
    bits: u8,
}
pub(crate) struct W {
    bits: u8,
}

impl StatusPipe {
    pub fn read(&self) -> R {
        R { bits: self.0 }
    }

    pub fn write<F>(&mut self, f: F)
    where
        F: FnOnce(&mut W) -> &mut W,
    {
        let mut w = W { bits: self.0 };
        f(&mut w);
        self.0 = w.bits;
    }
}

impl From<u8> for StatusPipe {
    fn from(v: u8) -> Self {
        Self(v)
    }
}

impl R {
    /// Value in raw bits.
    pub fn bits(&self) -> u8 {
        self.bits
    }

    pub fn ercnt(&self) -> ErCntR {
        let bits = {
            const POS: u8 = 5;
            const MASK: u8 = 0x7;
            ((self.bits >> POS) & MASK) as u8
        };

        ErCntR(bits)
    }

    pub fn crc16er(&self) -> CRC16ErR {
        let bits = {
            const POS: u8 = 4;
            const MASK: u8 = 1;
            ((self.bits >> POS) & MASK) == 1
        };

        CRC16ErR(bits)
    }

    pub fn touter(&self) -> TOutErrR {
        let bits = {
            const POS: u8 = 3;
            const MASK: u8 = 1;

            ((self.bits >> POS) & MASK) == 1
        };

        TOutErrR(bits)
    }

    pub fn pider(&self) -> PIDErR {
        let bits = {
            const POS: u8 = 2;
            const MASK: u8 = 1;

            ((self.bits >> POS) & MASK) == 1
        };

        PIDErR(bits)
    }

    pub fn dapider(&self) -> DaPIDErR {
        let bits = {
            const POS: u8 = 1;
            const MASK: u8 = 1;

            ((self.bits >> POS) & MASK) == 1
        };

        DaPIDErR(bits)
    }

    pub fn dtgler(&self) -> DTglErR {
        let bits = {
            const POS: u8 = 0;
            const MASK: u8 = 1;

            ((self.bits >> POS) & MASK) == 1
        };

        DTglErR(bits)
    }
}

/// Pipe Error Counter
///
/// The number of errors detected on the pipe.
pub(crate) struct ErCntR(u8);
impl ErCntR {
    pub fn bits(&self) -> u8 {
        self.0
    }
}

/// CRC16 ERROR
///
/// This bit defines the CRC16 Error Status.
///
/// This bit is set when a CRC 16 error has been detected during a IN
/// transactions.
pub(crate) struct CRC16ErR(bool);
impl CRC16ErR {
    pub fn bit(&self) -> bool {
        self.0
    }

    pub fn bit_is_set(&self) -> bool {
        self.bit()
    }

    pub fn bit_is_clear(&self) -> bool {
        !self.bit_is_set()
    }
}

/// TIME OUT ERROR
///
/// This bit defines the Time Out Error Status.
///
/// This bit is set when a Time Out error has been detected during a
/// USB transaction.
pub(crate) struct TOutErrR(bool);
impl TOutErrR {
    pub fn bit(&self) -> bool {
        self.0
    }

    pub fn bit_is_set(&self) -> bool {
        self.bit()
    }

    pub fn bit_is_clear(&self) -> bool {
        !self.bit_is_set()
    }
}

/// PID ERROR
///
/// This bit defines the PID Error Status.
///
/// This bit is set when a PID error has been detected during a USB
/// transaction.
pub(crate) struct PIDErR(bool);
impl PIDErR {
    pub fn bit(&self) -> bool {
        self.0
    }

    pub fn bit_is_set(&self) -> bool {
        self.bit()
    }

    pub fn bit_is_clear(&self) -> bool {
        !self.bit_is_set()
    }
}

/// Data PID ERROR
///
/// This bit defines the PID Error Status.
///
/// This bit is set when a Data PID error has been detected during a
/// USB transaction.
pub(crate) struct DaPIDErR(bool);
impl DaPIDErR {
    pub fn bit(&self) -> bool {
        self.0
    }

    pub fn bit_is_set(&self) -> bool {
        self.bit()
    }

    pub fn bit_is_clear(&self) -> bool {
        !self.bit_is_set()
    }
}

/// Data Toggle Error
///
/// This bit defines the Data Toggle Error Status.
///
/// This bit is set when a Data Toggle Error has been detected.
pub(crate) struct DTglErR(bool);
impl DTglErR {
    pub fn bit(&self) -> bool {
        self.0
    }

    pub fn bit_is_set(&self) -> bool {
        self.bit()
    }

    pub fn bit_is_clear(&self) -> bool {
        !self.bit_is_set()
    }
}

impl W {
    /// Write raw bits.
    pub unsafe fn bits(&mut self, v: u8) -> &mut Self {
        self.bits = v;
        self
    }

    pub fn ercnt(&mut self) -> ErCntW {
        ErCntW { w: self }
    }

    pub fn crc16er(&mut self) -> CRC16ErW {
        CRC16ErW { w: self }
    }

    pub fn touter(&mut self) -> TOutErW {
        TOutErW { w: self }
    }

    pub fn pider(&mut self) -> PIDErW {
        PIDErW { w: self }
    }

    pub fn dapider(&mut self) -> DaPIDErW {
        DaPIDErW { w: self }
    }

    pub fn dtgler(&mut self) -> DTglErW {
        DTglErW { w: self }
    }
}

/// Pipe Error Counter
///
/// The number of errors detected on the pipe.
pub(crate) struct ErCntW<'a> {
    w: &'a mut W,
}
impl<'a> ErCntW<'a> {
    pub unsafe fn bits(self, v: u8) -> &'a mut W {
        const POS: u8 = 5;
        const MASK: u8 = 0x7;
        self.w.bits &= !((MASK as u8) << POS);
        self.w.bits |= ((v & MASK) as u8) << POS;
        self.w
    }

    pub fn set_count(self, v: u8) -> &'a mut W {
        unsafe { self.bits(v) }
    }
}

/// CRC16 ERROR
///
/// This bit defines the CRC16 Error Status.
///
/// This bit is set when a CRC 16 error has been detected during a IN
/// transactions.
pub(crate) struct CRC16ErW<'a> {
    w: &'a mut W,
}
impl<'a> CRC16ErW<'a> {
    pub fn bit(self, v: bool) -> &'a mut W {
        const POS: u8 = 4;
        const MASK: bool = true;
        self.w.bits &= !((MASK as u8) << POS);
        self.w.bits |= ((v & MASK) as u8) << POS;
        self.w
    }

    pub fn set_bit(self) -> &'a mut W {
        self.bit(true)
    }

    pub fn clear_bit(self) -> &'a mut W {
        self.bit(false)
    }
}

/// TIME OUT ERROR
///
/// This bit defines the Time Out Error Status.
///
/// This bit is set when a Time Out error has been detected during a
/// USB transaction.
pub(crate) struct TOutErW<'a> {
    w: &'a mut W,
}
impl<'a> TOutErW<'a> {
    pub fn bit(self, v: bool) -> &'a mut W {
        const POS: u8 = 3;
        const MASK: bool = true;
        self.w.bits &= !((MASK as u8) << POS);
        self.w.bits |= ((v & MASK) as u8) << POS;
        self.w
    }

    pub fn set_bit(self) -> &'a mut W {
        self.bit(true)
    }

    pub fn clear_bit(self) -> &'a mut W {
        self.bit(false)
    }
}

/// PID ERROR
///
/// This bit defines the PID Error Status.
///
/// This bit is set when a PID error has been detected during a USB
/// transaction.
pub(crate) struct PIDErW<'a> {
    w: &'a mut W,
}
impl<'a> PIDErW<'a> {
    pub fn bit(self, v: bool) -> &'a mut W {
        const POS: u8 = 2;
        const MASK: bool = true;
        self.w.bits &= !((MASK as u8) << POS);
        self.w.bits |= ((v & MASK) as u8) << POS;
        self.w
    }

    pub fn set_bit(self) -> &'a mut W {
        self.bit(true)
    }

    pub fn clear_bit(self) -> &'a mut W {
        self.bit(false)
    }
}

/// Data PID ERROR
///
/// This bit defines the PID Error Status.
///
/// This bit is set when a Data PID error has been detected during a
/// USB transaction.
pub(crate) struct DaPIDErW<'a> {
    w: &'a mut W,
}
impl<'a> DaPIDErW<'a> {
    pub fn bit(self, v: bool) -> &'a mut W {
        const POS: u8 = 1;
        const MASK: bool = true;
        self.w.bits &= !((MASK as u8) << POS);
        self.w.bits |= ((v & MASK) as u8) << POS;
        self.w
    }

    pub fn set_bit(self) -> &'a mut W {
        self.bit(true)
    }

    pub fn clear_bit(self) -> &'a mut W {
        self.bit(false)
    }
}

/// Data Toggle Error
///
/// This bit defines the Data Toggle Error Status.
///
/// This bit is set when a Data Toggle Error has been detected.
pub(crate) struct DTglErW<'a> {
    w: &'a mut W,
}
impl<'a> DTglErW<'a> {
    pub fn bit(self, v: bool) -> &'a mut W {
        const POS: u8 = 0;
        const MASK: bool = true;
        self.w.bits &= !((MASK as u8) << POS);
        self.w.bits |= ((v & MASK) as u8) << POS;
        self.w
    }

    pub fn set_bit(self) -> &'a mut W {
        self.bit(true)
    }

    pub fn clear_bit(self) -> &'a mut W {
        self.bit(false)
    }
}