search

hackndev / zinc

The bare metal stack for rust
zinc.rs
Apache License 2.0
1k stars 100 forks source link

Pre-compiled ioregs RFC #365

Open farcaller opened 8 years ago

farcaller commented 8 years ago

This is one of the topics I want to discuss as part of RFC party (#359), and I finally cleaned up code enough to share it.

https://github.com/farcaller/zinc-hal-lpc11xx (api doc) provides a Cargoized hal layer for single MCU family (actually only ioregs now). It's generated with yasha (#341) with some modifications, most notably additional renaming/cleanup step (you can see the modification rules here). It also fixes #344 and makes few modifications to the layout, most notably it supports sparse peripherals by addressing not the peripheral but individual registers.

bharrisau commented 8 years ago

Significantly less magic (which is a good thing). Having docs are good, but it would be good if the docs were more modular. That is, the front page only has the high level structs - ADC, CT16B0, CT32B0, etc.

Then under ADC you have ADC_cr, ADC_dr0, ADC_dr1, etc. And the _Get and _Update are hidden another layer down.

I'd suggest we also document a guideline on how much of the module semantics is included, otherwise I can forsee us ending up with a [poor] copy of the device reference manual in the module docs.

Am I correct in assuming the HAL layer lives here too, and the Zinc crate will define some general traits that zinc-hal-lpc11xx would implement?

farcaller commented 8 years ago

Then under ADC you have ADC_cr, ADC_dr0, ADC_dr1, etc. And the _Get and _Update are hidden another layer down

good idea

I'd suggest we also document a guideline on how much of the module semantics is included

well, that's what we have in SVD, should be a very basic description, right?

Am I correct in assuming the HAL layer lives here too

Yep, I'll clean that part in a few days. I got problems making this work with crates.io version of volatile_cell.

farcaller commented 8 years ago

Things are progressing slower than I'd want, but anyways, here's the deal:

kblomqvist commented 8 years ago

I'm ok with the patch :)

kblomqvist commented 8 years ago

I made a new pip release of yasha, so the needed changes are more readily available. https://github.com/kblomqvist/yasha/releases/tag/1.5