summaryrefslogtreecommitdiffstats
path: root/spec/spec/interface-register-bits.yml
blob: 7205811f974ce404e0df6bd4f50d94683e85f3b6 (plain) (blame)
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
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
copyrights:
- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
links:
- role: spec-member
  uid: root
spec-description: null
spec-example: null
spec-info:
  none: null
  dict:
    attributes:
      properties:
        description: |
          It shall be the list of bit field properties.  Properties are for
          example if the bit field can be read or written, or an access has
          side-effects such as clearing a status.
        spec-type: list-str
      brief:
        description: null
        spec-type: interface-brief
      description:
        description: null
        spec-type: interface-description
      name:
        description: |
          It shall be the name of the register bit field.
        spec-type: str
      start:
        description: |
          It shall be the start bit of the bit field.  Bit ``0`` is the
          least-significant bit.
        spec-type: int
      width:
        description: |
          It shall be the width in bits of the bit field.
        spec-type: int
    description: |
      This set of attributes specifies a register bit field.  Single bits are
      bit fields with a width of one.
    mandatory-attributes: all
spec-name: Register Bits Definition
spec-type: interface-register-bits
type: spec