Skip to content

Commit

Permalink
new file: hardware/avr/2.2.1/.gitignore
Browse files Browse the repository at this point in the history
  • Loading branch information
@jodaguth
jodaguth committed Mar 20, 2023
0 parents commit a361ed0
Show file tree
Hide file tree
Showing 9,206 changed files with 435,542 additions and 0 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
1 change: 1 addition & 0 deletions hardware/avr/2.2.1/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.DS_Store
354 changes: 354 additions & 0 deletions hardware/avr/2.2.1/.travis.yml

Large diffs are not rendered by default.

752 changes: 752 additions & 0 deletions hardware/avr/2.2.1/LICENSE

Large diffs are not rendered by default.

301 changes: 301 additions & 0 deletions hardware/avr/2.2.1/PlatformIO.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,301 @@
# PlatformIO

[PlatformIO](https://platformio.org) is an open source ecosystem for embedded development.
It has a built-in library manager and is Arduino compatible. It supports most operating systems; Windows, MacOS, Linux 32 and 64-bit, ARM and X86.
And best of all, MiniCore is supported!

* [What is PlatformIO?](http://docs.platformio.org/en/latest/what-is-platformio.html)
* [PlatformIO IDE](http://platformio.org/#!/platformio-ide)
* Getting started with [PlatformIO IDE](http://docs.platformio.org/en/latest/ide/atom.html#quick-start) or [PlatformIO command line interface](http://docs.platformio.org/en/latest/quickstart.html)
* [Advanced functionality](http://docs.platformio.org/en/latest/platforms/atmelavr.html)
* [Project Examples](http://docs.platformio.org/en/latest/platforms/atmelavr.html#examples)


## MiniCore + PlatformIO
MiniCore and PlatformIO goes great together. You can do serial uploads and upload using a dedicated programmer, but you can also let PlatformIO calulate the fuses and load the correct bootloader file, just like Arduino IDE does!

PlatformIO uses the information provided in platformio.ini to calculate what fuse bits and what bootloader file to load.
Simply provide enough information and run the following commands:

```ini
; Only set fuses
pio run -t fuses -e fuses_bootloader
; Set fuses and burn bootloader
pio run -t bootloader -e fuses_bootloader
; (where "fuses_bootloader" can be replace with a different environment to match your build configuration)
```

You can find a platformio.ini template you can use when creating a project for a MiniCore compatible device below.
The most common functionality is available in this template. As you can see, the templated is divided into multiple environments.

* The default build environment are defined under `[platformio]`.
* All parameters that are common for all environments are defined under `[env]`.
* Use `[env:Upload_UART]` or `[env:Upload_ISP]` to upload to your target.
* Use `[env:fuses_bootloader]` to set the fuses or burn the bootloader.

More information on what each line means can be found futher down on this page.


## platformio.ini template

``` ini
; PlatformIO Project Configuration File for MiniCore
; https://github.com/MCUdude/MiniCore/
;
; Build options: build flags, source filter
; Upload options: custom upload port, speed, and extra flags
; Library options: dependencies, extra library storages
; Advanced options: extra scripting
;
; Please visit documentation for the other options
; https://github.com/MCUdude/MiniCore/blob/master/PlatformIO.md
; https://docs.platformio.org/page/projectconf.html


[platformio]
default_envs = Upload_UART ; Default build target


; Common settings for all environments
[env]
platform = atmelavr
framework = arduino

; TARGET SETTINGS
; Chip in use
board = ATmega328P
; Clock frequency in [Hz]
board_build.f_cpu = 16000000L

; BUILD OPTIONS
; Comment out to enable LTO (this line unflags it)
build_unflags = -flto
; Extra build flags
build_flags =

; SERIAL MONITOR OPTIONS
; Serial monitor port defined in the Upload_UART environment
monitor_port = ${env:Upload_UART.upload_port}
; Serial monitor baud rate
monitor_speed = 9600


; Run the following command to upload with this environment
; pio run -e Upload_UART -t upload
[env:Upload_UART]
; Serial bootloader protocol
upload_protocol = arduino
; Serial upload port
upload_port = /dev/cu.usbserial*
; Get upload baud rate defined in the fuses_bootloader environment
board_upload.speed = ${env:fuses_bootloader.board_bootloader.speed}


; Run the following command to upload with this environment
; pio run -e Upload_ISP -t upload
[env:Upload_ISP]
; Custom upload procedure
upload_protocol = custom
; Avrdude upload flags
upload_flags =
-C$PROJECT_PACKAGES_DIR/tool-avrdude/avrdude.conf
-p$BOARD_MCU
-PUSB
-cusbasp
; Avrdude upload command
upload_command = avrdude $UPLOAD_FLAGS -U flash:w:$SOURCE:i


; Run the following command to set fuses
; pio run -e fuses_bootloader -t fuses
; Run the following command to set fuses + burn bootloader
; pio run -e fuses_bootloader -t bootloader
[env:fuses_bootloader]
board_hardware.oscillator = external ; Oscillator type
board_hardware.uart = uart0 ; Set UART to use for serial upload
board_bootloader.speed = 115200 ; Set bootloader baud rate
board_hardware.bod = 2.7v ; Set brown-out detection
board_hardware.eesave = yes ; Preserve EEPROM when uploading using programmer
upload_protocol = usbasp ; Use the USBasp as programmer
upload_flags = ; Select USB as upload port and divide the SPI clock by 8
-PUSB
-B8

```


### `board`
PlatformIO requires the `board` parameter to be present.
The table below shows what board name should be used for each target

| Target | Board name |
|-----------------------------------------------------------------|---------------|
| ATmega328PB | `ATmega328PB` |
| ATmega328P/PA | `ATmega328P` |
| ATmega328 | `ATmega328` |
| ATmega168PB | `ATmega168PB` |
| ATmega168P/PA | `ATmega168P` |
| ATmega168/A | `ATmega168` |
| ATmega88PB | `ATmega88PB` |
| ATmega88P/PA | `ATmega88P` |
| ATmega88/A | `ATmega88` |
| ATmega48PB | `ATmega48PB` |
| ATmega48P/PA | `ATmega48P` |
| ATmega48/A | `ATmega48` |
| ATmega8/A | `ATmega8` |


### `board_build.f_cpu`
Specifies the clock frequency in [Hz].
Used to determine what oscillator option to choose. A capital L has to be added to the end of the frequency number.
Below is a table with supported clocks for MiniCore. Defaults to 16 MHz if not specified.

| Clock speed | Oscillator | board_build.f_cpu |
|-------------|------------|---------------------------|
| 20 MHz | External | `20000000L` |
| 18.432 MHz | External | `18432000L` |
| 16 MHz | External | `16000000L` (default) |
| 14.7456 MHz | External | `14745600L` |
| 12 MHz | External | `12000000L` |
| 11.0592 MHz | External | `11059200L` |
| 8 MHz | External | `8000000L` |
| 7.3728 MHz | External | `7372800L` |
| 3.6864 MHz | External | `3686400L` |
| 1.8432 MHz | External | `1843200L` |
| 8 MHz | Internal | `8000000L` |
| 1 MHz | Internal | `1000000L` |


### `board_hardware.oscillator`
Spefices to use the internal or an external oscillator.
Internal oscillator only works with `board_build.f_cpu` values `8000000L` and `1000000L`.

| Oscillator option |
|----------------------|
| `external` (default) |
| `internal` |


### `board_hardware.uart`
Specifies the hardware UART port used for serial upload. Use `no_bootloader` if you’re using a dedicated programmer, i.e not using a bootloader for serial upload.

| Upload serial port option |
|---------------------------|
| `no_bootloader` |
| `uart0` (default) |
| `uart1` (328PB only) |


### `board_hardware.bod`
Specifies the hardware brown-out detection. Use `disabled` to disable.

| ATmega48/88/168/328 | ATmega8 |
|---------------------|------------------|
| `4.3v` | `4.0v` |
| `2.7v` (default) | `2.7v` (default) |
| `1.8v` | |
| `disabled` | `disabled` |


### `board_hardware.eesave`
Specifies if the EEPROM memory should be retained when uploading using a programmer. Use `no` to disable.

| EEPROM retain |
|-----------------|
| `yes` (default) |
| `no` |


### `board_hardware.ckout`
Enable clock output on pin PB0 on targets that supports it (ATmega48/88/168/328).

| Clock output enable |
|---------------------|
| `yes` |
| `no` (default) |


### `board_hardware.cfd`
Enable clock failure detection. The internal 1 MHz oscillator will kick in if the external oscillator fails (only available on ATmega328PB).

| Clock failure detection |
|-------------------------|
| `yes` |
| `no` (default) |


### `board_upload.speed` / `board_bootloader.speed`
Specifies the upload baud rate. Available baud rates is shown in the table below, had has to corrolate with `build_board.f_cpu`.

**Note that if you're using a programmer that communicates with Avrdude with a serial port (Arduino as ISP, STK500, etc.) the `board_upload.speed` field will interfere with the programmer's baud rate.
In this case, use `board_bootloader.speed` to set the bootloader baud rate, and `board_upload.speed` to set the baud rate for the programmer.**

Recommended baud rate for the particular clock speed is in **bold text**.

| | 1000000 | 500000 | 460800 | 250000 | 230400 | 115200 | 57600 | 38400 | 19200 | 9600 |
|-------------|---------|--------|--------|--------|--------|--------|--------|--------|-------|--------|
| `20000000L` | | X | | X | | **X** | | | X | |
| `18432000L` | | | X | | X | **X** | X | X | X | X |
| `16000000L` | X | X | | X | | **X** | | X | X | X |
| `14745600L` | | | X | | X | **X** | X | X | X | X |
| `12000000L` | | X | | X | | | **X** | | X | X |
| `11059200L` | | | X | | X | X | **X** | X | X | X |
| `8000000L` | X | X | | X | | X | X | **X** | X | X |
| `7372800L` | | | X | | X | **X** | X | X | X | X |
| `3686400L` | | | X | | X | **X** | X | X | X | X |
| `1843200L` | | | | | X | **X** | X | X | X | X |
| `1000000L` | | | | | | | | | | **X** |


### `build_unflags`
This parameter is used to unflag. Since LTO is enabled by default in PlatformIO we may disable it by unflagging `-flto`.


### `build_flags`
This parameter is used to set compiler flags. This is useful if you want to for instance want to chage the serial RX or TX buffer. Here's a list of the current available core files flags:

### `build_flags`
This parameter is used to set compiler flags. This is useful if you want to for instance want to chage the serial RX or TX buffer. Here's a list of the current available core files flags:

| Flag | Default size | Description |
|-----------------------------|--------------|-----------------------------------------------------------|
| -lprintf_flt | | Lets you print floats with printf (occupies ~1.5 kB) |
| -Wall -Wextra | | Show all compiler warnings |
| -DSERIAL_RX_BUFFER_SIZE=128 | 64 bytes | Sets the serial RX buffer to 128 bytes |
| -DSERIAL_TX_BUFFER_SIZE=128 | 64 bytes | Sets the serial TX buffer to 128 bytes |
| -DTWI_BUFFER_SIZE=64 | 32 bytes | Sets the TWI (i2c) buffer to 64 bytes |
| -DTWI1_BUFFER_SIZE=64 | 32 bytes | Sets the TWI1 (i2c) buffer to 64 bytes (ATmega328PB only) |
| -DWIRE_TIMEOUT | | Enable timeout for the Wire and Wire1 library |

**Example:**
`build_flags = -DSERIAL_RX_BUFFER_SIZE=128 -DSERIAL_TX_BUFFER_SIZE=128`


### `upload_port`
Specifies the serial port used for uploading. PlatformIO automatically detects the serial port. However, if you want to override this you can uncomment `upload_port`. Use `/dev/[port]` on Unix compatible systems, and use `COMx` on Windows.


### `upload_protocol`
Used when using a programmer rather than using a USB to serial adapter.
Supports all Avrdude compatible programmers such as `usbasp`, `usbtiny` and `stk500v1`.


### `upload_flags`
Used to pass extra flags to Avrdude when uploading using a programmer.
Typical parameters are `-PUSB`, `-B[clock divider]` and `-b[baudrate]`.
**Note that every flag has to be on its own line, and they have to be indented with two spaces:**
```ini
upload_flags =
-PUSB
-B32
-v
```


### `monitor_port`
PlatformIO detects serial ports automatically. However, In the template above it uses the upload port defined in the `env:Upload_UART` environment.
if you want to override this you can insert your upload port here. Use `/dev/[port]` on Unix compatible systems, and use `COMx` on Windows.


### `monitor_speed`
Sets the serial monitor baud rate. Defaults to 9600 if not defined.
Loading

0 comments on commit a361ed0

Please sign in to comment.