User Tools

Site Tools


en:users:drivers:ath10k:codingstyle

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
Next revision Both sides next revision
en:users:drivers:ath10k:codingstyle [2018/04/12 13:37]
Kalle Valo Move Linux coding style and checking code sections to the beginning of the page
en:users:drivers:ath10k:codingstyle [2018/04/13 11:16]
Kalle Valo Add section for error message
Line 146: Line 146:
  ​*/</​code>​  ​*/</​code>​
  
 +==== Error messages ====
 +
 +For warning and error messages we have ath10k_warn() and ath10k_err().
 +
 +ath10k_warn() should be used when ath10k still continues to work, for example then some limit has been reached or an unknown event has been received. It's also rate limited.
 +
 +ath10k_err() should be used when a fatal error has been detected and ath10k will shut itself down, for example during driver initialisation or firmware recover fails. It is NOT rate limited.
 +
 +==== Debug messages ====
 +
 +Use ath10k_dbg() or ath10k_dbg_dump().
 +
 +The format string for ath10k_dbg() should start with debug level followed by name of the command or event and then parameters. All uppercase and no commas, colons or periods.
 +
 +Examples:
 +
 +<​code>​ath10k_dbg(ar,​ ATH10K_DBG_BOOT,​ "boot suspend complete\n"​);​
 +
 +ath10k_dbg(ar,​ ATH10K_DBG_WMI,​ "wmi mgmt tx skb %pK len %d ftype %02x stype %02x\n",​
 +    msdu, skb->​len,​ fc & IEEE80211_FCTL_FTYPE,​
 +    fc & IEEE80211_FCTL_STYPE);​
 +
 +ath10k_dbg(ar,​ ATH10K_DBG_MAC,​ "mac update sta %pM peer bw %d\n",
 +    ​sta->​addr,​ bw);
 +</​code>​
 ==== Things NOT to do ==== ==== Things NOT to do ====
  
en/users/drivers/ath10k/codingstyle.txt ยท Last modified: 2023/08/01 21:12 by Jeff Johnson