lufa-rs 0.1.1

Rust bindings and utility macros for the LUFA library.
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

# lufa-rs

This crate provides Rust raw bindings for the LUFA (Lightweight USB Framework for AVRs) library. It also contains some utility functions and macros to easily create HID (Human Interface Device) applications.


## Installation

Add to your `Cargo.toml` file:

```toml
[dependencies]
lufa-rs = "0.1"
```

## Usage

LUFA needs some environment variables to be set for the build process. You can set them in your `.cargo/config` file:

```toml
[env]
F_CPU="16000000"
ARCH="ARCH_AVR8"
BOARD="BOARD_USBKEY"
MMCU="atmega32u4"
LUFA_CONFIG_PATH = { value = ".", relative = true }
```

A `LUFAConfig.h` file needs to be present in the `LUFA_CONFIG_PATH` directory. See [LUFA devices examples](https://github.com/abcminiuser/lufa/tree/master/Demos) or [rust-keyboard](https://github.com/supersurviveur/rust-keyboard/tree/main/qmk/LUFAConfig.h) to create one.

Then you can use the library in your project:

```rust
use core::arch::asm;
use lufa_rs::{USB_Init, USB_USBTask};

fn main() {
    // USB initialization before enabling interrupts
    unsafe {
        USB_Init();
    }
    // Other initialization code, then enabling interrupts
    unsafe {
        asm!("sei");
    }
    // Your main loop
    loop {
        // Your code
        unsafe {
            USB_USBTask();
        }
    }
}
```

Some extern functions must be implemented for the library to work correctly. See any [LUFA example](https://github.com/abcminiuser/lufa/tree/master/Demos) for details.

## Examples

LUFA demos can be found in the [LUFA repository](https://github.com/abcminiuser/lufa/tree/master/Demos).

See the [rust-keyboard](https://github.com/supersurviveur/rust-keyboard/) repository for usage cases.
The library is used [here](https://github.com/supersurviveur/rust-keyboard/tree/main/qmk/src/usb)

## Contribution

Contributions are welcome! Open an issue or a pull request.

## License

This project is licensed under the MIT License.