Data.SVD.Util

Documentation

addReservedFields :: Device -> Device

Fill in reserved fields for whole Device

procFields :: Register -> [Field]

Find holes in registers and create corresponding reserved fields for these

First finds missing bits and then merges them to single reserved field

continuityCheck :: Register -> Bool

Walk processed register fields top to bottom checking that the register is exactly n bits long

checkDeviceRegisterContinuity :: Device -> Either String Device

Check all devices registers for continuity

mapPeriphs :: (Peripheral -> b) -> Device -> [b]

mapRegs :: (Register -> b) -> Peripheral -> [b]

mapFields :: (Field -> b) -> Register -> [b]

mapDevFields :: (Field -> b) -> Device -> [b]

getPeriphByGroup :: String -> Device -> Peripheral

Get peripheral by groupName

getPeriph :: String -> Device -> Peripheral

Get peripheral by name

getPeriphMay :: String -> Device -> Maybe Peripheral

Get peripheral by name iff found, Nothing otherwise

getPeriphRegMay :: String -> Peripheral -> Maybe Register

Get register of the peripheral by their names iff found, Nothing otherwise

getPeriphFollow :: String -> Device -> Either String Peripheral

Get peripheral by name or its parent peripheral if it's a derived peripheral (for example USART2 is typically derived from USART1)

getPeriphRegs :: String -> Device -> Either String [Register]

Get registers of the peripheral

getPeriphReg :: String -> String -> Device -> Either String Register

Get specific register of the peripheral Follows derived from.

getPeriphRegAddr :: String -> String -> Device -> Either String Int

Get address of the specific register of the peripheral with pName

getPeriphRegFields

Arguments

:: String

Peripheral name

-> String

Register name

-> Device

-> Either String [Field]

Get fields of the specific register of the peripheral with pName

getRegFields

Arguments

:: String

Peripheral name

-> String

Register name

-> Device

-> [Field]

getFieldVal :: (Bits a, Num a) => a -> Field -> a

Get value of specific Field according to input x

getFieldValues :: (Bits a, Num a) => a -> [Field] -> [(a, Field)]

Decode integer x according to Fields fs

getProcdFieldValues :: (Bits a, Num a) => a -> Register -> [(a, Field)]

Same as getFieldValues but with processed fields (reserved fields included)

anyReservedSet :: (Eq a, Num a) => [(a, Field)] -> Bool

Check if any reserved field has value other than 0

filterSet :: (Eq a, Num a) => [(a, Field)] -> [(a, Field)]

Filter fields with non zero value

getDevMemMap :: Device -> [(String, String)]

Get memory map of the device according to its perhiperal addresses

registerNames :: String -> Device -> [String]

fieldNames :: String -> String -> Device -> [String]

Sorting

sortDeviceByAddresses :: Device -> Device

Sort everything by memory address

sortDeviceByNames :: Device -> Device

Sort everything by name

Interrupts

fillMissingInterrupts :: [Interrupt] -> [Interrupt]