arm-generic-timer 0.2.0

Arm Generic Timer driver
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

# Arm Generic Timer driver

Driver implementation for the memory mapped and system register based Generic Timer peripheral of
the Arm A-profile architecture. The implementation is based on the following sections of the
[Arm Architecture Reference Manual for A-profile architecture](https://developer.arm.com/documentation/ddi0487/maa/).

* D24.10 Generic Timer registers
* I2.2.3 Counter module control and status register summary
* I2.3 Memory-mapped timer components
* I5.6 Generic Timer memory-mapped registers overview
* I5.7 Generic Timer memory-mapped register descriptions

## Implemented features

* Memory mapped generic timer
  * Register descriptions and drivers for the following frames:
    * `CNTControlBase`
    * `CNTCTLBase`
    * `CNTReadBase`
    * `CNTBaseN`
    * `CNTEL0BaseN`
* System register based generic timer
  * Physical Secure Timer
  * Hypervisor Physical Timer
  * Secure EL2 Physical Timer
  * EL2 Virtual Timer
  * Secure EL2 Virtual Timer
  * Physical Timer
  * Virtual Timer
* Generic delay timer logic

## Feature flags

- `el1`: Enables system register based timers which relies on EL1 system registers.
- `el2`: Enables system register based timers which relies on EL2 system registers.
- `fakes`: Accesses fake system registers rather than the real ones, for running tests on the host.

## License

The project is MIT and Apache-2.0 dual licensed, see `LICENSE-APACHE` and `LICENSE-MIT`.

## Maintainers

arm-generic-timer is a trustedfirmware.org maintained project. All contributions are ultimately merged by the
maintainers listed below.

* Bálint Dobszay <balint.dobszay@arm.com>
  [balint-dobszay-arm](https://github.com/balint-dobszay-arm)
* Imre Kis <imre.kis@arm.com>
  [imre-kis-arm](https://github.com/imre-kis-arm)
* Sandrine Afsa <sandrine.afsa@arm.com>
  [sandrine-bailleux-arm](https://github.com/sandrine-bailleux-arm)

## Contributing

Please follow the directions of the [Trusted Firmware Processes](https://trusted-firmware-docs.readthedocs.io/en/latest/generic_processes/index.html)

Contributions are handled through [review.trustedfirmware.org](https://review.trustedfirmware.org/q/project:arm-firmware-crates/arm-generic-timer).

## Arm trademark notice

Arm is a registered trademark of Arm Limited (or its subsidiaries or affiliates).

This project uses some of the Arm product, service or technology trademarks, as listed in the
[Trademark List][1], in accordance with the [Arm Trademark Use Guidelines][2].

Subsequent uses of these trademarks throughout this repository do not need to be prefixed with the
Arm word trademark.

[1]: https://www.arm.com/company/policies/trademarks/arm-trademark-list
[2]: https://www.arm.com/company/policies/trademarks/guidelines-trademarks

--------------

*Copyright The arm-generic-timer Contributors.*