lowRISC / lowRISC/opentitan

[lc_ctrl] Add SOC_DBG_ prefix to the enumerated values in lc_ctrl_state.hjson

Open
#28,407 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
SystemVerilog
Stars
3.6k
Forks
1.1k
Avg merge
2d 22h
Merged PRs (30d)
141

Description

A nit, but it is slightly confusing that the documentation (including this comment) uses the string "SOC_DBG_{BLANK,PRE_PROD,PROD}" for the enumerated values of the debug states, but the enumeration in `lc_ctrl_state.hjson` is just {BLANK,PRE_PROD,PROD}. It would be good to align these two at some point, and I would suggest adding "SOC_DBG_" to the enumerations in lc_ctrl_state.hjson.

_Originally posted by @hcallahan-lowrisc in https://github.com/lowRISC/opentitan/pull/28403#discussion_r2397445239_

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open lc_ctrl_state.hjson and compare its enumerated debug-state values with the documented SOC_DBG_* names mentioned in the issue. Align the enumeration names with that documented prefix, then verify the file remains consistent with the referenced documentation and comment.

Written by the indexing model from the issue text.

Assessment

Domain
embedded-iot, security
Issue type
Refactor
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.