Module registers

Module registers 

Source
Expand description

§Register based structures

This mod builds on the Interface trait defined in the bus module and defines a series of structs that mirror the common register types of many peripherals.

§Sub byte

Often a byte will be broken down in to bits or a couple of bits and you must then write code to bit shift and merge existing config to write or bit mask and bit shift to read.

This code dose this for you, for very time critical code, bus specific code may be valuable but for many registers this code can save time and code lines.

§Multi byte

The first two Multi byte implementations are CrossByteBitStructI16 and ByteStructI16

The CrossByteBitStructI16 allows you to mange values that are less than or equal to 16 bits in size were they value is split over 2 bytes.

The CrossByteBitStructI16 structure allows for you to retrieve a number of I16 values in adjacent registers.

Structs§

BitStruct
Struct for representing registers of 0-8bits
ByteStructI16
A Struct to map a number of 16bit integers to a number of consecutive registers
CrossByteBitStructI16
A register for interacting with 0-16bits over two consecutive bytes/registers

Enums§

BitByteStructError
A error type returned by many of the structures in this mod