sdnellen / open-register-design-tool

Tool to generate register RTL, models, and docs using SystemRDL or JSpec input
Apache License 2.0
15 stars 3 forks source link

Enumerattion description field missing from xml #21

Closed tkafafi closed 3 years ago

tkafafi commented 4 years ago

Please add the enumeration description field highlighted in bold to the generated xml. Thanks

e.g RDL:

field STS { reset = 0; hw = w; sw = r; }; //RO reg {STS dma_rch_reg[1:0];} sts_fsm; sts_fsm->desc="Finite State Machines Status Register"; sts_fsm.dma_rch_reg->desc="State of DMA Registers Read Channel statemachine"; enum fsm_dma_rch { STATE_IDLE = 2'h0 {desc = "Idle";}; STATE_READ_REQ = 2'h1 {desc = "Request arbitration";}; STATE_READ_DATA = 2'h2 {desc = "Data phase";}; STATE_ERR = 2'h3 {desc = "Error state";}; }; sts_fsm.dma_rch_reg->encode=fsm_dma_rch;

Requested XML output: (add )

    <enum_encode>
      <enc_name>fsm_dma_rch</enc_name>
      <enc_elem>
        <enc_elem_name>STATE_IDLE</enc_elem_name>
        <enc_elem_value>0x0</enc_elem_value>
        <enc_elem_desc><![CDATA[Idle]]></enc_elem_desc>
      </enc_elem>
      <enc_elem>
        <enc_elem_name>STATE_READ_REQ</enc_elem_name>
        <enc_elem_value>0x1</enc_elem_value>
        <enc_elem_desc><![CDATA[Request arbitration]]></enc_elem_desc>
      </enc_elem>
      <enc_elem>
        <enc_elem_name>STATE_READ_DATA</enc_elem_name>
        <enc_elem_value>0x2</enc_elem_value>
        <enc_elem_desc><![CDATA[Data phase]]></enc_elem_desc>
      </enc_elem>
      <enc_elem>
        <enc_elem_name>STATE_ERR</enc_elem_name>
        <enc_elem_value>0x3</enc_elem_value>
        <enc_elem_desc><![CDATA[Error state]]></enc_elem_desc>
      </enc_elem>
    </enum_encode>
sdnellen commented 4 years ago

submitted mod to add enc_elem_desc

tkafafi commented 3 years ago

Hi Scott Can you please make a release of the jar with these updates.

Thanks

Get Outlook for iOShttps://aka.ms/o0ukef


From: Scott Nellenbach notifications@github.com Sent: Tuesday, October 27, 2020 1:05:57 PM To: sdnellen/open-register-design-tool open-register-design-tool@noreply.github.com Cc: tkafafi tkafafi@hotmail.com; Author author@noreply.github.com Subject: Re: [sdnellen/open-register-design-tool] Enumerattion description field missing from xml (#21)

Closed #21https://github.com/sdnellen/open-register-design-tool/issues/21.

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHubhttps://github.com/sdnellen/open-register-design-tool/issues/21#event-3927925906, or unsubscribehttps://github.com/notifications/unsubscribe-auth/AGWO4LLX2OBW5KTESCFOMXDSM4R2LANCNFSM4LVYIVCQ.