Skip to content

Commit

Permalink
changelog prepped for v2.0 -- cleaned up/moved some stuff around. (#406)
Browse files Browse the repository at this point in the history
Co-authored-by: stephenhensley <[email protected]>
  • Loading branch information
stephenhensley and stephenhensley authored Sep 28, 2021
1 parent b2b8943 commit 4001564
Showing 1 changed file with 31 additions and 19 deletions.
50 changes: 31 additions & 19 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,28 @@

### Breaking Changes

### Features

### Other

## v2.0.0

### Breaking Changes

* qspi: updated from C to C++, and fixed up the API to be cleaner, and simpler to use
* sdram: Create SdramHandle class. Gets rid of configurable pin and hardcodes it instead.
* sdram: updated from C to C++
* Create SdramHandle class. Gets rid of configurable pin and hardcodes it instead.

### Features

* adc: added initialization mappings for pins ADC1_INP12 (PC2) and ADC1_INP13 (PC3) (Not accessible on Daisy Seed)
* bootloader: added `program-app` make target to upload code to the daisy bootloader
* board: added support files for upcoming Daisy Patch SM hardware
* rng: added new Random module that provides access to the hardware True Random Number Generator
* spi: added DMA Transactions (same type of queue system as I2C) to the SPI Handle class.
* sdram: Update from c to cpp.
* util: added new PersistentStorage class for storing/recalling data between power cycles
* util: added new VoctCalibration helper class for calibrating ADC inputs
* seed: added support for Daisy Seed 1.1 (aka Daisy Seed rev5) hardware. Pin-compatible, with same form factor. WM8731 Codec instead of AK4556.
* bootloader: added `program-app` make target to upload code to the daisy bootloader

### Bug fixes

Expand All @@ -26,12 +34,13 @@

### Other

* bootloader: added deinits and memory-aware inits for bootloader compatibility
* util: added deinits and memory-aware inits for bootloader compatibility

### Migrating

#### QSPI
~~~c++

```c++
DaisySeed hw;
// ...

Expand All @@ -44,22 +53,25 @@ dsy_qspi_write(address, size, (uint8_t*)&some_data);
// New -- qspi mode is automatically handled
hw.qspi.Erase(address, address + sector_size);
hw.qspi.Write(address, size, (uint8_t*)&some_data);
~~~
```
#### Sdram
This is only applicable if you had a seed-level board that needed to initialize external SDRAM.
#### Sdram:
``` cpp
```cpp
//Init
//Old:
dsy_gpio_pin *pin_group;
dsy_sdram_handle sdram_handle;
sdram_handle.state = DSY_SDRAM_STATE_ENABLE;
pin_group = sdram_handle.pin_config;
pin_group[DSY_SDRAM_PIN_SDNWE] = dsy_pin(DSY_GPIOH, 5);
dsy_sdram_init(&sdram_handle);
//New:
SdramHandle sdram;
sdram.Init();
//Old:
dsy_gpio_pin *pin_group;
dsy_sdram_handle sdram_handle;
sdram_handle.state = DSY_SDRAM_STATE_ENABLE;
pin_group = sdram_handle.pin_config;
pin_group[DSY_SDRAM_PIN_SDNWE] = dsy_pin(DSY_GPIOH, 5);
dsy_sdram_init(&sdram_handle);
//New:
SdramHandle sdram;
sdram.Init();
```

## v1.0.0
Expand Down

0 comments on commit 4001564

Please sign in to comment.