Field Properties ================ .. note:: Any properties not explicitly listed here are either implicitly supported, or are not relevant to the regblock exporter and are ignored. Software Access Properties -------------------------- onread/onwrite ^^^^^^^^^^^^^^ |OK| rclr/rset ^^^^^^^^^ See ``onread`` singlepulse ^^^^^^^^^^^ |OK| If set, field will get cleared back to zero after being written. .. wavedrom:: {signal: [ {name: 'clk', wave: 'p.....'}, {name: '', wave: '0.10..'}, {name: 'hwif_out..value', wave: '0..10.'} ]} sw ^^^ |OK| swacc ^^^^^ |OK| If true, infers an output signal ``hwif_out..swacc`` that is asserted on the same clock cycle that the field is being sampled during a software read operation. .. wavedrom:: {signal: [ {name: 'clk', wave: 'p....'}, {name: 'hwif_in..value', wave: 'x.=x.', data: ['D']}, {name: 'hwif_out..swacc', wave: '0.10.'} ]} swmod ^^^^^ |OK| If true, infers an output signal ``hwif_out..swmod`` that is asserted as the field is being modified by software. .. wavedrom:: {signal: [ {name: 'clk', wave: 'p.....'}, {name: 'hwif_out..value', wave: '=..=..', data: ['old', 'new']}, {name: 'hwif_out..swmod', wave: '0.10..'} ]} swwe/swwel ^^^^^^^^^^ Provides a mechanism that allows hardware to override whether the field is writable by software. boolean |OK| If True, infers an input signal ``hwif_in..swwe`` or ``hwif_in..swwel``. reference |OK| woclr/woset ^^^^^^^^^^^ See ``onwrite`` -------------------------------------------------------------------------------- Hardware Access Properties -------------------------- anded/ored/xored ^^^^^^^^^^^^^^^^ |OK| If true, infers the existence of output signal: ``hwif_out..anded``, ``hwif_out..ored``, ``hwif_out..xored`` hw ^^^ |OK| Controls hardware access to the field. If readable, enables output signal ``hwif_out..value``. If writable, enables input ``hwif_in..value``. hwclr/hwset ^^^^^^^^^^^ If both ``hwclr`` and ``hwset`` properties are used, and both are asserted at the same clock cycle, then ``hwset`` will take precedence. boolean |OK| If true, infers the existence of input signal: ``hwif_in..hwclr``, ``hwif_in..hwset`` reference |OK| hwenable/hwmask ^^^^^^^^^^^^^^^ |OK| Reference to a component that provides bit-level control of hardware writeability. we/wel ^^^^^^ Write-enable control from hardware interface. If true, infers the existence of input signal: ``hwif_in..we``, ``hwif_in..wel`` .. wavedrom:: {signal: [ {name: 'clk', wave: 'p....'}, {name: 'hwif_in..value', wave: 'x.=x.', data: ['D']}, {name: 'hwif_in..we', wave: '0.10.',}, {name: 'hwif_in..wel', wave: '1.01.',}, {name: '', wave: 'x..=.', data: ['D']} ]} boolean |OK| If true, infers the existence of input signal ``hwif_in..we`` or ``hwif_in..wel`` reference |OK| -------------------------------------------------------------------------------- Counter Properties ------------------ counter ^^^^^^^ |OK| If true, marks this field as a counter. The counter direction is inferred based based on which properties are assigned. By default, an up-counter is implemented. If any of the properties associated with an up-counter are used, then up-counting capabilities will be implemented. The same is true for down-counters and up/down counters. Unless alternate control signals are specified, the existence of input signals ``hwif_in..incr`` and ``hwif_in..decr`` will be inferred depending on the type of counter described. incr ^^^^ |OK| Assign a reference to an alternate control signal to increment the counter. If assigned, the inferred ``hwif_in..incr`` input will not be generated. incrsaturate/saturate ^^^^^^^^^^^^^^^^^^^^^ If assigned, indicates that the counter will saturate instead of wrapping. If an alternate saturation point is specified, the counter value will be adjusted so that it does not exceed that limit, even after non-increment actions. boolean |OK| If true, saturation point is at the counter's maximum count value. (2^width - 1) integer |OK| Specify a static saturation value. reference |OK| Specify a dynamic saturation value. incrthreshold/threshold ^^^^^^^^^^^^^^^^^^^^^^^ If assigned, infers a ``hwif_out..incrthreshold`` output signal. This signal is asserted if the counter value is greater or equal to the threshold. .. wavedrom:: { signal: [ {name: 'clk', wave: 'p......'}, {name: 'hwif_in..incr', wave: '01...0.'}, {name: '', wave: '=.=3==..', data: [4,5,6,7,8,9]}, {name: 'hwif_out..incrthreshold', wave: '0..1....'} ], foot: { text: "Example where incrthreshold = 6" } } boolean |OK| If true, threshold is the counter's maximum count value. (2^width - 1) integer |OK| Specify a static threshold value. reference |OK| Specify a dynamic threshold value. incrvalue ^^^^^^^^^ Override the counter's increment step size. integer |OK| reference |OK| incrwidth ^^^^^^^^^ |OK| If assigned, infers an input signal ``hwif_in..incrvalue``. The value of this property defines the signal's width. overflow ^^^^^^^^ |OK| If true, infers an output signal ``hwif_out..overflow`` that is asserted when the counter is about to wrap. .. wavedrom:: { signal: [ {name: 'clk', wave: 'p.......'}, {name: 'hwif_in..incr', wave: '0101010.'}, {name: '', wave: '=.=.=.=.', data: [14,15,0,1]}, {name: 'hwif_out..overflow', wave: '0..10...'} ], foot: { text: "A 4-bit counter overflowing" } } decr ^^^^ |OK| Assign a reference to an alternate control signal to decrement the counter. If assigned, the inferred ``hwif_in..decr`` input will not be generated. decrsaturate ^^^^^^^^^^^^ If assigned, indicates that the counter will saturate instead of wrapping. If an alternate saturation point is specified, the counter value will be adjusted so that it does not exceed that limit, even after non-decrement actions. boolean |OK| If true, saturation point is when the counter reaches 0. integer |OK| Specify a static saturation value. reference |OK| Specify a dynamic saturation value. decrthreshold ^^^^^^^^^^^^^ If assigned, infers a ``hwif_out..decrthreshold`` output signal. This signal is asserted if the counter value is less than or equal to the threshold. .. wavedrom:: { signal: [ {name: 'clk', wave: 'p......'}, {name: 'hwif_in..decr', wave: '01...0.'}, {name: '', wave: '=.=3==..', data: [9,8,7,6,5,4]}, {name: 'hwif_out..decrthreshold', wave: '0..1....'} ], foot: { text: "Example where incrthreshold = 7" } } boolean |OK| If true, threshold is 0. integer |OK| Specify a static threshold value. reference |OK| Specify a dynamic threshold value. decrvalue ^^^^^^^^^ Override the counter's decrement step size. integer |OK| reference |OK| decrwidth ^^^^^^^^^ |OK| If assigned, infers an input signal ``hwif_in..decrvalue``. The value of this property defines the signal's width. underflow ^^^^^^^^^ |OK| If true, infers an output signal ``hwif_out..underflow`` that is asserted when the counter is about to wrap. .. wavedrom:: { signal: [ {name: 'clk', wave: 'p.......'}, {name: 'hwif_in..decr', wave: '0101010.'}, {name: '', wave: '=.=.=.=.', data: [1,0,15,14]}, {name: 'hwif_out..underflow', wave: '0..10...'} ], foot: { text: "A 4-bit counter underflowing" } } -------------------------------------------------------------------------------- Interrupt Properties -------------------- enable ^^^^^^ |NO| haltenable ^^^^^^^^^^ |NO| haltmask ^^^^^^^^ |NO| intr ^^^^ |NO| mask ^^^^ |NO| sticky ^^^^^^ |NO| stickybit ^^^^^^^^^ |NO| -------------------------------------------------------------------------------- Misc ---- encode ^^^^^^ |NO| next ^^^^ |NO| paritycheck ^^^^^^^^^^^ |NO| precedence ^^^^^^^^^^ |EX| reset ^^^^^ integer |OK| reference |OK| resetsignal ^^^^^^^^^^^ |OK|