Re: Register info types suggestions

[Bob Beims <bob.beims@freescale.com>]

Title: Re: Register info types suggestions

Duane;

Sorry it took me so long to get to this. I’ve taken your element list and turned it into a wiki table @ 

http://wiki.oasis-open.org/dita/Semiconductor/RegisterElements

Should provide a great start for tomorrow’s discussions.

Regards,
Bob

---

From: Duane K Becker <dkbecker@us.ibm.com>
Date: Fri, 21 Sep 2007 10:21:34 -0700
To: <dita-sidsc@lists.oasis-open.org>
Conversation: [dita-sidsc] Register info types suggestions
Subject: [dita-sidsc] Register info types suggestions


Here are all the register infotypes I could find that we at IBM might use for Dita Semiconductor specialization.


Register information Elements (Submitted by Duane Becker)

Register Block Long Name
Register Block Short Name
Register Block Base Address               If offset is not used, then base address is the primary address.
Register Block Offset                      Starting offset from Register Block Base Address for this register block.
Register Block Short Description       For what is this register block essentially used?
Register Block Long Description               Detailed accounting of the purpose of this register block.

Register Long Name
Register Short Name

Register Overall Description       This is a synopsis of a register, a brief "what is it used for". This might
                              be used as a pop-up help for a debugger tool.

Register Detailed Description       This is a more detailed overall description of a register, but doesn't
                              necessarily go into bit field-level descriptions.

Register Base Address
Register Offset Address
Register Access Type               (read/write, read/clear, read/set, write only, read only, etc)
Register Access Granularity       Byte, Word, Doubleword, etc.
Dimension1                       If this is a single register, then Dimension1 must equal 0. If the register is
                              a linear array, this indicates how many rows there are in the array.
Dimension2                       If this is a single register or a linear array, this value must equal 0.
                              If this is a rectangular array, this provides the number of columns.
OffsetDelta1                       This indicates the incremental address offset to Dimension1 for each repeated row.
OffsetDelta2                       This indicates the incremental address offfset to Dimension2 for each repeated column.

Reset Value                       Hexadecimal without any special annunciators. The target post-processor
                              would have to format it as required by the individual company's style. 'X' can
                              be used to indicate that the register is not reset to any particular value.
                              
Reset Triggers                      A set of codes or values or bitnames or signalnames that indicate
                              what actions can reset the register.


__________________________________________________
Duane K. Becker     IBM Burlington, Vermont
Phone 1-802-769-1892     Tie Line 446-1892
__________________________________________________
Nature abhors a vacuum. So does my sister's dog.