bitband.h — Maple v0.0.11 Documentation

### Navigation

- next
- previous |
- LeafLabs |
- Index »
- `libmaple` »
- APIs »

# `bitband.h`

[Stub] support.

## Library Documentation

> Bit-banding utility functions.

> Defines

> > BB_SRAM_REF

> > BB_SRAM_BASE

> > BB_PERI_REF

> > BB_PERI_BASE

> Functions

> > uint32 * __bb_addr(volatile void * address, uint32 bit, uint32 bb_base, uint32 bb_ref)

> > uint32 * bb_sramp(volatile void * address, uint32 bit)

> >   Obtain a pointer to the bit-band address corresponding to a bit in a volatile SRAM address.

> >   Parameters:

> >   - `address` -

> >     Address in the bit-banded SRAM region

> >   - `bit` -

> >     Bit in address to bit-band

> > uint8 bb_sram_get_bit(volatile void * address, uint32 bit)

> >   Get a bit from an address in the SRAM bit-band region.

> >   Parameters:

> >   - `address` -

> >     Address in the SRAM bit-band region to read from

> >   - `bit` -

> >     Bit in address to read

> >   Return: | bit’s value in address.

> > void bb_sram_set_bit(volatile void * address, uint32 bit, uint8 val)

> >   Set a bit in an address in the SRAM bit-band region.

> >   Parameters:

> >   - `address` -

> >     Address in the SRAM bit-band region to write to

> >   - `bit` -

> >     Bit in address to write to

> >   - `val` -

> >     Value to write for bit, either 0 or 1.

> > uint32 * bb_perip(volatile void * address, uint32 bit)

> >   Obtain a pointer to the bit-band address corresponding to a bit in a peripheral address.

> >   Parameters:

> >   - `address` -

> >     Address in the bit-banded peripheral region

> >   - `bit` -

> >     Bit in address to bit-band

> > uint8 bb_peri_get_bit(volatile void * address, uint32 bit)

> >   Get a bit from an address in the peripheral bit-band region.

> >   Parameters:

> >   - `address` -

> >     Address in the peripheral bit-band region to read from

> >   - `bit` -

> >     Bit in address to read

> >   Return: | bit’s value in address.

> > void bb_peri_set_bit(volatile void * address, uint32 bit, uint8 val)

> >   Set a bit in an address in the peripheral bit-band region.

> >   Parameters:

> >   - `address` -

> >     Address in the peripheral bit-band region to write to

> >   - `bit` -

> >     Bit in address to write to

> >   - `val` -

> >     Value to write for bit, either 0 or 1.

### Navigation

- next
- previous |
- LeafLabs |
- Index »
- `libmaple` »
- APIs »