{"id":5817,"date":"2020-03-24T19:45:04","date_gmt":"2020-03-25T02:45:04","guid":{"rendered":"https:\/\/visualgdb.com\/w\/?p=5817"},"modified":"2021-07-20T09:20:33","modified_gmt":"2021-07-20T16:20:33","slug":"editing-hardware-register-definitions","status":"publish","type":"post","link":"https:\/\/visualgdb.com\/documentation\/hwregs\/","title":{"rendered":"Editing Hardware Register Definitions"},"content":{"rendered":"

Most of the device families supported by VisualGDB include definitions for the peripheral registers that allow viewing and modifying those registers conveniently via the Hardware Registers window:\"\"<\/a>For legacy projects that are created by manually specifying the compiler settings, the hardware registers won’t be automatically shown. To fix this, open the VisualGDB Project Properties window and set the peripheral register definition file:\"\"<\/a>You can also use the link at the bottom of the Hardware Registers window to import the definition file into VisualGDB:\"\"<\/a>If you are using Quick Debug without a BSP, you can specify the path to a hardware register definition file as shown below:\"\"<\/a><\/p>\n

The register definition file is an XML file with the following structure:<\/p>\n

<?xml version=\"1.0\"?>\r\n<MCUDefinition xmlns:xsi=\"http:\/\/www.w3.org\/2001\/XMLSchema-instance\" xmlns:xsd=\"http:\/\/www.w3.org\/2001\/XMLSchema\">\r\n<MCUName>DeviceName<\/MCUName>\r\n<RegisterSets>\r\n    <HardwareRegisterSet>\r\n        <ExpressionPrefix>TIM2-&gt;<\/ExpressionPrefix>\r\n        <UserFriendlyName>TIM2<\/UserFriendlyName>\r\n        <Registers>\r\n            <HardwareRegister>\r\n            <!-- ... -->\r\n            <\/HardwareRegister>\r\n        <\/Registers>\r\n    <\/HardwareRegisterSet>\r\n<\/RegisterSets>\r\n<\/MCUDefinition><\/pre>\n
Each register set corresponds to a group of registers corresponding to the same peripheral (e.g. timer or USB). The UserFriendlyName<\/strong> element contains the name of the group as shown in the Hardware Registers window. The  ExpressionPrefix<\/strong> element allows matching C\/C++ Watch expressions (e.g. TIM2->CR1 to specific hardware registers defined in a peripheral register definition file).<\/p>\n
Each HardwareRegister<\/strong> element corresponds to one register inside a register set. It has the following structure:<\/p>\n
<HardwareRegister>\r\n    <Name>CR1<\/Name>\r\n    <SizeInBits>32<\/SizeInBits>\r\n    <Address>0x40000000<\/Address>\r\n    <ReadOnly>false<\/ReadOnly>\r\n    <SubRegisters>\r\n        <HardwareSubRegister>\r\n            <Name>CEN<\/Name>\r\n            <FirstBit>0<\/FirstBit>\r\n            <SizeInBits>1<\/SizeInBits>\r\n        <\/HardwareSubRegister>\r\n        <HardwareSubRegister>\r\n            <Name>UDIS<\/Name>\r\n            <FirstBit>1<\/FirstBit>\r\n            <SizeInBits>1<\/SizeInBits>\r\n        <\/HardwareSubRegister>\r\n        <HardwareSubRegister>\r\n            <Name>CMS<\/Name>\r\n            <FirstBit>5<\/FirstBit>\r\n            <SizeInBits>2<\/SizeInBits>\r\n            <KnownValues>\r\n                <KnownSubRegisterValue>\r\n                    <Name>EDGE<\/Name>\r\n                <\/KnownSubRegisterValue>\r\n                <KnownSubRegisterValue>\r\n                    <Name>CENTER1<\/Name>\r\n                <\/KnownSubRegisterValue>\r\n                <KnownSubRegisterValue>\r\n                    <Name>CENTER2<\/Name>\r\n                <\/KnownSubRegisterValue>\r\n                <KnownSubRegisterValue>\r\n                    <Name>CENTER3<\/Name>\r\n                <\/KnownSubRegisterValue>\r\n            <\/KnownValues>\r\n        <\/HardwareSubRegister>\r\n    <\/SubRegisters>\r\n<\/HardwareRegister><\/pre>\n
Each HardwareSubRegister<\/strong> element corresponds to a meaningful group of bits inside the hardware register: VisualGDB will use the following rules when showing subregisters:<\/p>\n