d1_pac/usb1/ehci_operational/
frindex.rs

1#[doc = "Register `frindex` reader"]
2pub type R = crate::R<FRINDEX_SPEC>;
3#[doc = "Register `frindex` writer"]
4pub type W = crate::W<FRINDEX_SPEC>;
5#[doc = "Field `frame_index` reader - Frame Index\n\nThe value in this register increment at the end of each time frame (e.g. micro-frame). Bits\\[N:3\\] are used for the Frame List current index. It means that each location of the frame list is accessed 8 times (frames or Micro-frames) before moving to the next index. The following illustrates values of N based on the value of the Frame List Size field in the USBCMD register."]
6pub type FRAME_INDEX_R = crate::FieldReader<u16>;
7#[doc = "Field `frame_index` writer - Frame Index\n\nThe value in this register increment at the end of each time frame (e.g. micro-frame). Bits\\[N:3\\] are used for the Frame List current index. It means that each location of the frame list is accessed 8 times (frames or Micro-frames) before moving to the next index. The following illustrates values of N based on the value of the Frame List Size field in the USBCMD register."]
8pub type FRAME_INDEX_W<'a, REG> = crate::FieldWriter<'a, REG, 14, u16>;
9impl R {
10    #[doc = "Bits 0:13 - Frame Index\n\nThe value in this register increment at the end of each time frame (e.g. micro-frame). Bits\\[N:3\\] are used for the Frame List current index. It means that each location of the frame list is accessed 8 times (frames or Micro-frames) before moving to the next index. The following illustrates values of N based on the value of the Frame List Size field in the USBCMD register."]
11    #[inline(always)]
12    pub fn frame_index(&self) -> FRAME_INDEX_R {
13        FRAME_INDEX_R::new((self.bits & 0x3fff) as u16)
14    }
15}
16impl W {
17    #[doc = "Bits 0:13 - Frame Index\n\nThe value in this register increment at the end of each time frame (e.g. micro-frame). Bits\\[N:3\\] are used for the Frame List current index. It means that each location of the frame list is accessed 8 times (frames or Micro-frames) before moving to the next index. The following illustrates values of N based on the value of the Frame List Size field in the USBCMD register."]
18    #[inline(always)]
19    #[must_use]
20    pub fn frame_index(&mut self) -> FRAME_INDEX_W<FRINDEX_SPEC> {
21        FRAME_INDEX_W::new(self, 0)
22    }
23    #[doc = r" Writes raw bits to the register."]
24    #[doc = r""]
25    #[doc = r" # Safety"]
26    #[doc = r""]
27    #[doc = r" Passing incorrect value can cause undefined behaviour. See reference manual"]
28    #[inline(always)]
29    pub unsafe fn bits(&mut self, bits: u32) -> &mut Self {
30        self.bits = bits;
31        self
32    }
33}
34#[doc = "EHCI Frame Index Register\n\nYou can [`read`](crate::generic::Reg::read) this register and get [`frindex::R`](R).  You can [`reset`](crate::generic::Reg::reset), [`write`](crate::generic::Reg::write), [`write_with_zero`](crate::generic::Reg::write_with_zero) this register using [`frindex::W`](W). You can also [`modify`](crate::generic::Reg::modify) this register. See [API](https://docs.rs/svd2rust/#read--modify--write-api)."]
35pub struct FRINDEX_SPEC;
36impl crate::RegisterSpec for FRINDEX_SPEC {
37    type Ux = u32;
38}
39#[doc = "`read()` method returns [`frindex::R`](R) reader structure"]
40impl crate::Readable for FRINDEX_SPEC {}
41#[doc = "`write(|w| ..)` method takes [`frindex::W`](W) writer structure"]
42impl crate::Writable for FRINDEX_SPEC {
43    const ZERO_TO_MODIFY_FIELDS_BITMAP: Self::Ux = 0;
44    const ONE_TO_MODIFY_FIELDS_BITMAP: Self::Ux = 0;
45}
46#[doc = "`reset()` method sets frindex to value 0"]
47impl crate::Resettable for FRINDEX_SPEC {
48    const RESET_VALUE: Self::Ux = 0;
49}