derive-mmio 0.8.0

A mechanism for making it easier to access MMIO peripherals
Documentation 
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

on:
  push:
    branches: [ main ]
  pull_request:

name: Build

jobs:

  # Define Rust versions dynamically
  setup:
    runs-on: ubuntu-latest
    outputs:
      matrix: ${{ steps.set-matrix.outputs.rust_versions }}
    steps:
      - id: set-matrix
        run: |
          echo 'rust_versions={"rust": ["stable", "1.85"]}' >> "$GITHUB_OUTPUT"

  # Build the library
  build:
    runs-on: ubuntu-latest
    needs: setup
    strategy:
      matrix: ${{ fromJSON(needs.setup.outputs.matrix) }}
    steps:
      - name: Checkout
        uses: actions/checkout@v7
      - name: Install rust
        run: |
          rustup install ${{ matrix.rust }}
          rustup default ${{ matrix.rust }}
      - name: Build
        run: |
          cargo build --examples

  # Cross-Build the library with no_std
  cross-build:
    runs-on: ubuntu-latest
    needs: setup
    strategy:
      matrix:
        rust: ${{ fromJSON(needs.setup.outputs.matrix).rust }}
        target:
          - thumbv7em-none-eabihf
    steps:
      - name: Checkout
        uses: actions/checkout@v7
      - name: Install rust
        run: |
          rustup install ${{ matrix.rust }}
          rustup default ${{ matrix.rust }}
          rustup target add ${{ matrix.target }}
      - name: Build
        run: |
          cargo build --manifest-path ./examples/no_std/Cargo.toml --target ${{ matrix.target }}

  # Build the macro
  build-macro:
    runs-on: ubuntu-latest
    needs: setup
    strategy:
      matrix: ${{ fromJSON(needs.setup.outputs.matrix) }}
    steps:
      - name: Checkout
        uses: actions/checkout@v7
      - name: Install rust
        run: |
          rustup install ${{ matrix.rust }}
          rustup default ${{ matrix.rust }}
      - name: Build
        run: |
          cd macro
          cargo build

  # Gather all the above build jobs together for the purposes of getting an overall pass-fail
  build-all:
    runs-on: ubuntu-latest
    needs: [build, build-macro, cross-build]
    steps:
      - run: /bin/true

  # Test the library
  test:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v7
      - name: Install rust
        run: |
          rustup install 1.85
          rustup default 1.85
      - run: cargo test --all-targets

  # Build the docs for the library
  docs:
    runs-on: ubuntu-latest
    needs: setup
    strategy:
      matrix: ${{ fromJSON(needs.setup.outputs.matrix) }}
    steps:
      - name: Checkout
        uses: actions/checkout@v7
      - name: Install rust
        run: |
          rustup install ${{ matrix.rust }}
          rustup default ${{ matrix.rust }}
      - name: Build docs
        run: |
          cargo doc --examples

  # Format the library
  fmt:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v7
      - name: Install rust
        run: |
          rustup install stable
          rustup default stable
      - name: Format Check
        run: |
          cargo fmt --check
      - name: Format Check for macro
        run: |
          cd macro
          cargo fmt --check

  # Run clippy on the library
  clippy:
    runs-on: ubuntu-latest
    needs: setup
    strategy:
      matrix: ${{ fromJSON(needs.setup.outputs.matrix) }}
    steps:
      - name: Checkout
        uses: actions/checkout@v7
      - name: Install rust
        run: |
          rustup install ${{ matrix.rust }}
          rustup default ${{ matrix.rust }}
          rustup component add clippy
      - name: Clippy
        run: |
          cargo clippy --examples
      - name: Clippy for the Macro
        run: |
          cd macro
          cargo clippy

  # Gather all the above xxx-all jobs together for the purposes of getting an overall pass-fail
  all:
    runs-on: ubuntu-latest
    needs: [docs, build-all, test, fmt] # not gating on clippy-all
    steps:
      - run: /bin/true