mirror of
https://github.com/saymrwulf/xous-core.git
synced 2026-11-19 09:00:54 +00:00
move comments to the correct file
This commit is contained in:
parent
68679f41ba
commit
9eb40aceb0
2 changed files with 12 additions and 8 deletions
|
|
@ -1,3 +1,12 @@
|
||||||
|
//! BIO API
|
||||||
|
//!
|
||||||
|
//! For the first draft of this API, we're going to take an approach where all machines
|
||||||
|
//! and pins are explicitly managed. That is: we don't try and be clever and try to imply any
|
||||||
|
//! allocations. The developer has to correctly identify which engine to place their code on,
|
||||||
|
//! and which I/Os, if any, the thing uses.
|
||||||
|
//!
|
||||||
|
//! Here is the reference for what register correspond to what functions in BIO:
|
||||||
|
//!
|
||||||
//! FIFO - 8-deep fifo head/tail access. Cores halt on overflow/underflow.
|
//! FIFO - 8-deep fifo head/tail access. Cores halt on overflow/underflow.
|
||||||
//! - x16 r/w fifo[0]
|
//! - x16 r/w fifo[0]
|
||||||
//! - x17 r/w fifo[1]
|
//! - x17 r/w fifo[1]
|
||||||
|
|
@ -30,9 +39,11 @@
|
||||||
//! Core ID & debug:
|
//! Core ID & debug:
|
||||||
//! - x31 r/- [31:30] -> core ID; [29:0] -> cpu clocks since reset
|
//! - x31 r/- [31:30] -> core ID; [29:0] -> cpu clocks since reset
|
||||||
|
|
||||||
|
// Other notes:
|
||||||
|
//
|
||||||
// clock divider equation:
|
// clock divider equation:
|
||||||
// output frequency = fclk / (div_int + div_frac / 256)
|
// output frequency = fclk / (div_int + div_frac / 256)
|
||||||
|
//
|
||||||
// WS2812B timings - base cycle time is 210ns
|
// WS2812B timings - base cycle time is 210ns
|
||||||
// 0: Hi 2 cycles, low 4 cycles
|
// 0: Hi 2 cycles, low 4 cycles
|
||||||
// 1: Hi 4 cycles, low 2 cycles
|
// 1: Hi 4 cycles, low 2 cycles
|
||||||
|
|
|
||||||
|
|
@ -1,10 +1,3 @@
|
||||||
//! BIO API
|
|
||||||
//!
|
|
||||||
//! For the first draft of this API, we're going to take an approach where all machines
|
|
||||||
//! and pins are explicitly managed. That is: we don't try and be clever and try to imply any
|
|
||||||
//! allocations. The developer has to correctly identify which engine to place their code on,
|
|
||||||
//! and which I/Os, if any, the thing uses.
|
|
||||||
|
|
||||||
use std::marker::PhantomData;
|
use std::marker::PhantomData;
|
||||||
|
|
||||||
use bao1x_api::bio::*;
|
use bao1x_api::bio::*;
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue