Split project structure to fw/hw, KiCad gitignore

This commit is contained in:
Ilya Elenskiy
2020-04-19 14:32:24 +02:00
parent 5d0b62bef5
commit a3b1d9cb11
16 changed files with 148 additions and 108 deletions

8
Firmware/.gitignore vendored Normal file
View File

@@ -0,0 +1,8 @@
depends
.pio
.vscode
.vscode/.browse.c_cpp.db*
.vscode/c_cpp_properties.json
.vscode/launch.json
.vscode/ipch

112
Firmware/README.md Normal file
View File

@@ -0,0 +1,112 @@
# DMM Demo
Beispielprojekt zur Demonstration der wesentlichen Funktionen des DMM-Boards.
Wird auch zur Installation des Bootloaders und Test nach der Inbetriebnahme
eingesetzt.
## Anleitung
### Build-System und Entwicklungsumgebung
Als plattformübergreifendes Build-System Dient das
[PlatformIO](https://platformio.org/). Diese steht sowohl als
Kommandozeilen-Tool, als auch als [Erweiterung](https://marketplace.visualstudio.com/items?itemName=platformio.platformio-ide)
zum [Visual Studio Code](https://code.visualstudio.com/).
(auch unter Linux und MacOS verfügbar!)
Nutzt man das VSCode, so können nach der Installation der Erweiterung die unten
aufgeführten Befehle auch *ohne Installation der PIO im Betriebssystem* in den
Terminals innerhalb der IDE genutzt werden. Für die Betriebssystemweite Installation
siehe Anleitung unter [PlatformIO Core (CLI)](https://docs.platformio.org/en/latest/core/installation.html).
*Nur Linux:* zur Programmierung des Bootloaders mit JTAGICE muss dieser
für nicht-root Nutzer per udev-Regel freigegeben werden. Erstelle dazu Datei
`/etc/udev/rules.d/99-jtagice3.rules` mit:
```
SUBSYSTEMS=="usb", ATTRS{idVendor}=="03eb", ATTRS{idProduct}=="2140", MODE="0666"
```
### Auschecken und bauen
Es sollte sichergestellt sein, dass [Git](https://git-scm.com/) installiert und
der [eigene SSH-Schlüssel im GitLab-Profil hinterlegt](https://docs.gitlab.com/ee/ssh/)
ist. Für Git-Anfänger finden sich im Internet zahlreiche Anleitungen, zum Beispiel
[diese](https://www.freecodecamp.org/news/learn-the-basics-of-git-in-under-10-minutes-da548267cc91/).
*GUI:* VSCode unterstützt Git direkt und kann nach der Einrichtung als GUI
genutzt werden.
Auschecken:
```
$ git clone git@teach.emg.ing.tu-bs.de:dmm/dmm-demo.git
$ cd dmm-demo
```
Es sind zwei PlatformIO-Environments definiert. `release` wird standardmäßig
genutzt und ist auf die Programmierung per Bootloader ausgelegt. `debug` wird
für das Aufspielen des Bootloaders oder Debugging mittels JTAGICE3 genutzt.
Bauen von `release`:
```
$ pio run
```
Bauen von `debug`:
```
$ pio run -e debug
```
Dabei werden neben der Toolchain automatisch die für DMM-Projekte vorgesehenen
[Bibliotheken](https://teach.emg.ing.tu-bs.de/git/dmm/dmm-libs) in den Ordner
`dmm-demo/depends` heruntergeladen.
### Programmierung & Nutzung
*GUI*: die aufgeführten Befehle können auch aus dem PlatformIO-Toolbar des
VSCode per Mausklick ausgeführt werden.
#### Aufspielen des Bootloaders
Auf einem neuen Board muss zunächst mittels JTAGICE3 ein Bootloader aufgespielt
werden. Dazu wird es mit dem JTAG-Header verbunden (Polung beachten!).
```
$ pio run -t bootloader -e debug
```
#### Aufspielen des Programms
Das Board muss per USB verbunden und Bootloader gestarted werden.
*Zum Start des Bootloaders den Joystick in Richtung unten halten, Reset-Taste
drücken und den Joystick loslassen. Die Aktivierung des Bootloaders erkennt man
an zwei leuchtenden roten LEDs auf dem Board*
```
$ pio run -t upload
```
Anschließend Reset-Taste drücken um das Programm zu starten.
#### UART-Kommunikation
Ein Teil des Demos beschäftigt sich mit Kommunikation über einen virtuellen
SerialPort via USB. Der `COMx` (Windows) oder `/dev/ttyUSBx` (Linux) Port wird
von PlattformIO automatisch erkannt. Dies geschieht anhand des `hwid` Parameters
unter `boards/emgdmm_v3.json`, der den VID/PID des FTDI-Chips des DMM-Boards
angibt. Ein Terminal kann somit einfach geöffnet werden:
```
pio device monitor
```
Beim Drücken des Joystick im entsprechenden Teil des Demos wird nun eine Meldung
angezeigt.
### Unit-Test
Die Demo enthält im Ordner `tests` einen Beispiel zur Ausführung von Unit-Tests
auf dem Mikrocontroller. Dazu muss wie oben beschrieben der Bootloader aktiviert
werden.
```
$ pio test
```
Nach dem Befehl wird eine Firmware auf das Board heruntergeladen, die bei der
Ausführung per UART (wie auch bei `pio device monitor`) die Ergebnisse der
Tests im Terminal ausgibt.

View File

@@ -0,0 +1,34 @@
{
"build": {
"f_cpu": "16000000L",
"hwids": [
[
"0x0403",
"0x6001"
]
],
"mcu": "atmega1284p"
},
"platforms": [
"atmelavr"
],
"name": "EMG DMM Board",
"upload": {
"maximum_ram_size": 16384,
"maximum_size": 126976,
"protocol": "stk500",
"require_upload_port": true
},
"bootloader": {
"file": "boards/stk500boot.hex",
"lfuse": "0xFF",
"hfuse": "0x98",
"efuse": "0xFF",
"lock_bits": "0xFF"
},
"test": {
"speed": 9600
},
"url": "https://www.emg.tu-bs.de/lehre/vl/vl_dmm_d.html",
"vendor": "EMG, TU braunschweig"
}

View File

@@ -0,0 +1,105 @@
:020000021000EC
:10F800008FEF90E49EBF8DBF11241FBE00C0CDB707
:10F81000DEB7C852D140DEBFCDBF81B1877081B99C
:10F8200082B1886F82B99FE094B985B18F6085B944
:10F830000699BEC294B98EE085B98091C0008260FD
:10F840008093C00080E190E09093C5008093C40055
:10F8500088E18093C10088249924540144245524CC
:10F8600032012224332460E0C05EDE4F1882C05291
:10F87000D14021E0C15EDE4F2883CF51D14042E02C
:10F8800050E04C0F5D1F4E5F5F4FC95DDE4F5983E7
:10F890004883C752D14088C22B988091C00087FF0F
:10F8A000FCCF85B1A8E08A2785B93091C600933096
:10F8B000A9F1943028F4913079F0923050F507C0D6
:10F8C0009530D1F1953088F1963031F747C03B3112
:10F8D00019F791E06BE1E0CF313071F0C15EDE4F9E
:10F8E000B881CF51D140BB2339F4C05EDE4FE881EF
:10F8F000C052D1403E17A9F56327C05EDE4F388362
:10F90000C052D14092E0C15EDE4F1882CF51D1404B
:10F91000C3CF532F40E0632793E0BECF832F90E007
:10F92000482B592B632794E0B7CF3E30D1F463279F
:10F9300095E022243324B0CFE2E0F0E0EC0FFD1F8D
:10F94000E20DF31D30830894211C311C632724161B
:10F95000350609F0A1CFA10196E09ECF361709F434
:10F9600030C290E099CF299A1B82F8E0FC8323E50E
:10F970002D8384E58E838BE48F8385E3888780E302
:10F9800089878A878FE58B8782E38C874BE050E0FD
:10F9900096C119828B81813991F0823938F481388E
:10F9A000B1F0803951F0803899F411C0843961F098
:10F9B000853969F0823961F405C08FE006C032E014
:10F9C000398306C08AE001C082E3898301C01982BD
:10F9D0001B8289818C8343E050E071C18E81882332
:10F9E00011F48EE12CC0813011F085E028C087E948
:10F9F00026C01B8229E0E1E0F0E0209357008491CB
:10FA00008C831D8244E050E05AC18C81803589F49A
:10FA10008D81883039F429E0E2E0F0E0209357004E
:10FA200084910DC029E0E0E0F0E02093570084913C
:10FA300006C029E0E3E0F0E02093570084911B82A8
:10FA4000DFCF80E090E0A0E0B0E033E0FC01A093E5
:10FA50005B0030935700E89507B600FCFDCF80505F
:10FA60009F4FAF4FBF4F80304CEF940740E0A4074B
:10FA700040E0B40751F71B824424552432011DC1D4
:10FA80008B8190E0A0E0B0E0B82EAA2499248824CD
:10FA90008C8190E0A0E0B0E0DC0199278827882ADB
:10FAA000992AAA2ABB2A8E8190E0A0E0B0E0882A99
:10FAB000992AAA2ABB2A8D8190E0A0E0B0E0BA2F53
:10FAC000A92F982F8827882A992AAA2ABB2A880C26
:10FAD000991CAA1CBB1C1B82F0C05FEF45165BEF94
:10FAE000550650E0650650E0750690F483E0F2019B
:10FAF00060925B0080935700E89507B600FCFDCF4D
:10FB000020E031E040E050E0420E531E641E751EBE
:10FB1000B501A4018E01045F1F4FF801808121818E
:10FB20000E5F1F4FCC5DDE4F2883C452D140CD5DA8
:10FB3000DE4F1882C352D14090E0CD5DDE4F288168
:10FB40003981C352D140822B932B31E00C01FA0151
:10FB500060935B0030935700E89511244E5F5F4F30
:10FB60006F4F7F4F1297C9F685E0F401A0925B00BA
:10FB700080935700E89507B600FCFDCF91E1909384
:10FB80005700E89525C0B501A401FE013C961197E8
:10FB90008D0120E030E00F5F1F4F2F4F3F4F080DCA
:10FBA000191D2A1D3B1D41BDBB27A72F962F852F51
:10FBB00082BD4F5F5F4F6F4F7F4F819180BDFA9A3B
:10FBC000F99AF999FECF401751076207730759F761
:10FBD0001B822A984A015B0170C0AB81CA5DDE4F6F
:10FBE000A883C652D140CB5DDE4F1882C552D140AA
:10FBF0008C81C82EDD24CB5DDE4FE881F981C552B2
:10FC0000D140CE2ADF2A1B828A818431F9F4A601F1
:10FC1000C95DDE4FE880F980C752D140ABBEF40128
:10FC200087919691D7018C9311969C93E2E0F0E036
:10FC3000EE0EFF1E82E090E0A0E0B0E0880E991E7C
:10FC4000AA1EBB1E4250504049F72FC0B501A40167
:10FC5000C95DDE4FE880F980C752D1400894C108E1
:10FC6000D108860120E030E00894C11CD11C0F5F50
:10FC70001F4F2F4F3F4F080D191D2A1D3B1D41BD22
:10FC8000BB27A72F962F852F82BD4F5F5F4F6F4FEA
:10FC90007F4FF89A80B5D7018D937D0140175107AA
:10FCA0006207730761F74A015B01A6014D5F5F4F71
:10FCB000F701108204C080EC8B8342E050E0FBE14E
:10FCC000F093C6008091C00086FFFCCF8091C000F9
:10FCD00080648093C000C05EDE4F2881C052D14056
:10FCE0002093C6008091C00086FFFCCF8091C000A9
:10FCF00080648093C000352F5093C6008091C0006F
:10FD000086FFFCCF8091C00080648093C000942F58
:10FD10004093C6008091C00086FFFCCF8091C00058
:10FD200080648093C0008EE08093C6008091C00004
:10FD300086FFFCCF8091C00080648093C00065E1A5
:10FD4000C05EDE4F8881C052D14068276927632793
:10FD5000FE01329610C090819093C6008091C00041
:10FD600086FFFCCF31968091C00080648093C000F4
:10FD70006927415050404115510569F76093C6000D
:10FD80008091C00086FFFCCF8091C000806480938A
:10FD9000C000C05EDE4F9881C052D1409F5FC05E00
:10FDA000DE4F9883C052D14090E040E050E074CDE7
:10FDB00081E180935700E89511241F921F920895C6
:10FDC000FFCF9A81923109F43CCE9331B0F4933055
:10FDD00009F4DFCD943038F4913009F4C4CD923079
:10FDE00009F069CF78CE963009F44ACE963008F4FF
:10FDF00062CF903108F45FCF6ECE963109F4EDCE2C
:10FE00009731F0F4943109F4E8CEAB81CE5DDE4F4A
:10FE1000A883C252D140CF5DDE4F1882C152D1407B
:10FE20008C81A82FB0E0CF5DDE4FE881F981C1520F
:10FE3000D140AE2BBF2B2A9A933109F0A4CE4DCEE0
:10FE40009A3109F4D6CD9B3109F4C8CD983109F027
:04FE500032CFDBCD05
:040000031000F800F1
:00000001FF

39
Firmware/include/README Normal file
View File

@@ -0,0 +1,39 @@
This directory is intended for project header files.
A header file is a file containing C declarations and macro definitions
to be shared between several project source files. You request the use of a
header file in your project source file (C, C++, etc) located in `src` folder
by including it, with the C preprocessing directive `#include'.
```src/main.c
#include "header.h"
int main (void)
{
...
}
```
Including a header file produces the same results as copying the header file
into each source file that needs it. Such copying would be time-consuming
and error-prone. With a header file, the related declarations appear
in only one place. If they need to be changed, they can be changed in one
place, and programs that include the header file will automatically use the
new version when next recompiled. The header file eliminates the labor of
finding and changing all the copies as well as the risk that a failure to
find one copy will result in inconsistencies within a program.
In C, the usual convention is to give header files names that end with `.h'.
It is most portable to use only letters, digits, dashes, and underscores in
header file names, and at most one dot.
Read more about using header files in official GCC documentation:
* Include Syntax
* Include Operation
* Once-Only Headers
* Computed Includes
https://gcc.gnu.org/onlinedocs/cpp/Header-Files.html

43
Firmware/include/music.h Normal file
View File

@@ -0,0 +1,43 @@
#ifndef MUSIC_H_
#define MUSIC_H_
typedef struct
{
uint16_t tone;
uint16_t duration;
} MUSIC_Note;
#define MUSIC_END { 0, 0 }
#define MUSIC_IS_END(_note_) (!((_note_).tone) && !((_note_).duration))
#define MUSIC_A4 440
#define MUSIC_B4 494
#define MUSIC_C4 262
#define MUSIC_D4 293
#define MUSIC_E4 330
#define MUSIC_F4 349
#define MUSIC_G4 392
#define MUSIC_A5 880
#define MUSIC_B5 988
#define MUSIC_C5 523
#define MUSIC_D5 587
#define MUSIC_E5 659
#define MUSIC_F5 698
#define MUSIC_G5 784
#define MUSIC_1 1000
#define MUSIC_2 (MUSIC_1/2)
#define MUSIC_4 (MUSIC_1/4)
#define MUSIC_8 (MUSIC_1/8)
#define MUSIC_16 (MUSIC_1/16)
#define MUSIC_32 (MUSIC_1/32)
typedef const MUSIC_Note* MUSIC_Track;
extern const MUSIC_Note MUSIC_Tetris[];
void Music_PlayTrack (MUSIC_Track track);
#endif /* MUSIC_H_ */

46
Firmware/lib/README Normal file
View File

@@ -0,0 +1,46 @@
This directory is intended for project specific (private) libraries.
PlatformIO will compile them to static libraries and link into executable file.
The source code of each library should be placed in a an own separate directory
("lib/your_library_name/[here are source files]").
For example, see a structure of the following two libraries `Foo` and `Bar`:
|--lib
| |
| |--Bar
| | |--docs
| | |--examples
| | |--src
| | |- Bar.c
| | |- Bar.h
| | |- library.json (optional, custom build options, etc) https://docs.platformio.org/page/librarymanager/config.html
| |
| |--Foo
| | |- Foo.c
| | |- Foo.h
| |
| |- README --> THIS FILE
|
|- platformio.ini
|--src
|- main.c
and a contents of `src/main.c`:
```
#include <Foo.h>
#include <Bar.h>
int main (void)
{
...
}
```
PlatformIO Library Dependency Finder will find automatically dependent
libraries scanning project source files.
More information about PlatformIO Library Dependency Finder
- https://docs.platformio.org/page/librarymanager/ldf.html

40
Firmware/platformio.ini Normal file
View File

@@ -0,0 +1,40 @@
; PlatformIO Project Configuration File
;
; 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 and examples
; https://docs.platformio.org/page/projectconf.html
[platformio]
default_envs = release
libdeps_dir = depends
[env]
platform = atmelavr
board = emgdmm_v3
test_transport = custom
test_speed = 9600
lib_deps =
git@teach.emg.ing.tu-bs.de:dmm/dmm-libs.git
[env:release] ; for flash via bootloader
; keep defaults, see board definitions for programming support
[env:debug] ; for JTAG bootloader flashing and potentialy debugging once supported
build_type = debug
build_flags = -D DEBUG
upload_protocol = jtag3
upload_flags = -p, atmega1284 ; fix signature error with JTAGICE
; Atmel-ICE based AVR debug is not directly supported by PIO as of 04.2020. As not
; available at home, not an issue for DMM at the moment.
; Potentially solveable by using avarice as a server.
; See: https://github.com/platformio/platform-atmelavr/issues/53

1089
Firmware/src/main.c Normal file

File diff suppressed because it is too large Load Diff

109
Firmware/src/music.c Normal file
View File

@@ -0,0 +1,109 @@
#include <stdint.h>
#include <avr/io.h>
#include <avr/pgmspace.h>
#include <util/delay.h>
#include <util/atomic.h>
#include "music.h"
/* Sine lookup table for the PWM generator (pp = 32) */
static const PROGMEM unsigned char sine_lookup[]={
0x10,0x13,0x16,0x19,0x1b,0x1d,0x1f,0x20,
0x20,0x20,0x1f,0x1d,0x1b,0x19,0x16,0x13,
0x10,0x0d,0x0a,0x07,0x05,0x03,0x01,0x00,
0x00,0x00,0x01,0x03,0x05,0x07,0x0a,0x0d
};
const MUSIC_Note MUSIC_Tetris[] = {
{ MUSIC_E5, MUSIC_4 },
{ MUSIC_B4, MUSIC_8 },
{ MUSIC_C5, MUSIC_8 },
{ MUSIC_D5, MUSIC_4 },
{ MUSIC_C5, MUSIC_8 },
{ MUSIC_D5, MUSIC_8 },
{ MUSIC_A4, MUSIC_4 },
{ MUSIC_A4, MUSIC_8 },
{ MUSIC_C5, MUSIC_8 },
{ MUSIC_E5, MUSIC_4 },
{ MUSIC_D5, MUSIC_8 },
{ MUSIC_C5, MUSIC_8 },
{ MUSIC_B4, MUSIC_4 + MUSIC_8 },
{ MUSIC_C5, MUSIC_8 },
{ MUSIC_D5, MUSIC_4 },
{ MUSIC_E5, MUSIC_4 },
{ MUSIC_C5, MUSIC_4 },
{ MUSIC_A4, MUSIC_4 },
{ MUSIC_A4, MUSIC_8 },
MUSIC_END };
static void delay_ms(uint16_t delay);
static void pwm_init (void);
static void pwm_deinit (void);
static void pwm_gen(uint16_t tone, uint16_t periods);
void Music_PlayTrack (MUSIC_Track track)
{
pwm_init();
while (!MUSIC_IS_END(*track)) {
if (track->tone == 0) {
delay_ms(track->duration);
} else {
uint16_t periods = (uint32_t)track->duration * (uint32_t)track->tone / 1000;
pwm_gen(track->tone, periods);
delay_ms(MUSIC_32 / 2);
}
++track;
}
pwm_deinit();
}
static void delay_ms(uint16_t delay)
{
while (delay--)
_delay_ms(1);
}
void pwm_init (void)
{
//setup PWM timer
DDRD |= _BV(PIND5); // speaker pin => output
TCCR1A = _BV(COM1A1) | _BV(COM1A0) | _BV(WGM10); //set on match
TCCR1B = _BV(CS10) | _BV(WGM12); //fast PWM (8 bit), clk/1 source
//setup sample timer (CTC Mode)
TCCR3A = 0;
TCCR3B = _BV(CS30) | _BV(WGM32); // clk/1
}
void pwm_deinit (void)
{
TCCR1A = 0;
TCCR1B = 0;
TCCR3A = 0;
TCCR3B = 0;
}
void pwm_gen(uint16_t tone, uint16_t periods)
{
//calculate single sine sample duration
OCR3A = F_CPU / tone / sizeof(sine_lookup) - 1;
for (uint16_t period=0; period < periods; ++period) {
for (uint8_t spl=0; spl < sizeof(sine_lookup); ++spl) {
//wait for timer ready for next spl
loop_until_bit_is_set(TIFR3, OCF1A);
TIFR3 = _BV(OCF1A); //clear OCF
OCR1A = pgm_read_byte(sine_lookup + spl) + 0x70;
}
}
}

11
Firmware/test/README Normal file
View File

@@ -0,0 +1,11 @@
This directory is intended for PIO Unit Testing and project tests.
Unit Testing is a software testing method by which individual units of
source code, sets of one or more MCU program modules together with associated
control data, usage procedures, and operating procedures, are tested to
determine whether they are fit for use. Unit testing finds problems early
in the development cycle.
More information about PIO Unit Testing:
- https://docs.platformio.org/page/plus/unit-testing.html

41
Firmware/test/test_demo.c Normal file
View File

@@ -0,0 +1,41 @@
#include <stdint.h>
#include <unity.h>
#include <util/delay.h>
#include "fifo.h"
#include "unittest_transport.h"
void test_fifo(void)
{
uint8_t buf[3];
fifo_t f;
fifo_init(&f, buf, sizeof(buf));
fifo_put(&f, 0x11);
fifo_put(&f, 0x22);
fifo_put(&f, 0x33);
TEST_ASSERT_EQUAL(fifo_get_nowait(&f), 0x11);
TEST_ASSERT_EQUAL(fifo_get_nowait(&f), 0x22);
TEST_ASSERT_EQUAL(fifo_get_nowait(&f), 0x33);
}
int main()
{
// NOTE!!! Wait for >2 secs
// if board doesn't support software reset via Serial.DTR/RTS
_delay_ms(2000);
DDRB |= 0x2;
PORTB &= ~0x2;
UNITY_BEGIN(); // IMPORTANT LINE!
RUN_TEST(test_fifo);
UNITY_END(); // stop unit testing
PORTB |= 0x2;
DDRB |= 0x4;
PORTB &= ~0x4;
while (1)
;
}

View File

@@ -0,0 +1,32 @@
#ifndef UNITTEST_TRANSPORT_H
#define UNITTEST_TRANSPORT_H
#include <avr/io.h>
#include <stdint.h>
#include "uart.h"
void unittest_uart_begin()
{
// Set Baudrate according to datasheet (16MHz -> 9600 Baud -> 103)
UBRR0 = 103;
UCSR0B |= (1<<TXEN0);
// Reset Complete-Flags
UCSR0A = (1 << RXC0) | (1 << TXC0);
}
void unittest_uart_putchar(char c)
{
loop_until_bit_is_set(UCSR0A, UDRE0);
UDR0 = c;
}
void unittest_uart_flush()
{
}
void unittest_uart_end()
{
}
#endif