Clash.Annotations.BitRepresentation.Util

Documentation

bitOrigins :: DataRepr' -> ConstrRepr' -> [BitOrigin]

Given a type size and one of its constructor this function will yield a specification of which bits the whole type is made up of. I.e., a construction plan on how to make the whole data structure, given its individual constructor fields.

bitOrigins' :: DataRepr' -> ConstrRepr' -> [BitOrigin]

Same as bitOrigins, but each item in result list represents a single bit.

bitRanges :: Integer -> [(Int, Int)]

Determine consecutively set bits in word. Will produce ranges from high to low. Examples:

bitRanges 0b10 == [(1,1)] bitRanges 0b101 == [(2,2),(0,0)] bitRanges 0b10011001111 == [(10,10),(7,6),(3,0)]

isContinuousMask :: Integer -> Bool

data BitOrigin

Result of various utilty functions. Indicates the origin of a certain bit: either a literal from the constructor (or an undefined bit), or from a literal.

Constructors

Lit [Bit]

Literal (high, low, undefind)

Field Int Int Int

Bits originate from a field. Field fieldnr from downto.

Instances

Show BitOrigin

Defined in Clash.Annotations.BitRepresentation.Util

Methods

showsPrec :: Int -> BitOrigin -> ShowS

show :: BitOrigin -> String

showList :: [BitOrigin] -> ShowS

data Bit

Constructors

H

High

L

Low

U

Undefined

Instances

Eq Bit

Defined in Clash.Annotations.BitRepresentation.Util

Methods

(==) :: Bit -> Bit -> Bool

(/=) :: Bit -> Bit -> Bool

Show Bit

Defined in Clash.Annotations.BitRepresentation.Util

Methods

showsPrec :: Int -> Bit -> ShowS

show :: Bit -> String

showList :: [Bit] -> ShowS