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
en:users:drivers:ath10k:codingstyle [2018/04/13 11:16]
Kalle Valo Add section for error message
en:users:drivers:ath10k:codingstyle [2018/08/24 09:30] (current)
Kalle Valo [Naming] Add register/unregister examples
Line 125: Line 125:
 Example: ​ Example: ​
  
 +<​code>​int ath10k_mac_start(struct ath10k *ar)</​code>​
  
-<​code>​int ath10k_init_hw(struct ath10k *ar)</​code>​ +For each component use function names create/​destroy for allocating and freeing something, ​register/unregister ​for initialising and cleaning up them afterwards and start/stop to temporarily pause something. ​
-For each component use function names create/​destroy for allocating and freeing something, ​init/cleanup ​for initialising ​variables ​and cleaning up them afterwards and start/stop to temporarily pause something. ​+
  
 Example: ​ Example: ​
Line 133: Line 133:
  
 <​code>​int ath10k_cfg80211_create(struct ath10k *ar) <​code>​int ath10k_cfg80211_create(struct ath10k *ar)
 +int ath10k_cfg80211_register(struct ath10k *ar)
 int ath10k_cfg80211_start(struct ath10k *ar) int ath10k_cfg80211_start(struct ath10k *ar)
 void ath10k_cfg80211_stop(struct ath10k *ar) void ath10k_cfg80211_stop(struct ath10k *ar)
-void ath10k_cfg80211_destory(struct ath10k *ar)</​code>​+int ath10k_cfg80211_unregister(struct ath10k *ar) 
 +void ath10k_cfg80211_destroy(struct ath10k *ar)</​code>​
  
 ==== Comments ==== ==== Comments ====
Line 153: Line 155:
  
 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. 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.
 +
 +Examples:
 +
 +  ath10k_warn(ar,​ "​failed to submit frame %d: %d\n", frame_index,​ ret);
 +  ath10k_err(ar,​ "​failed to wake up the device from sleep: %d\n", ret);
  
 ==== Debug messages ==== ==== Debug messages ====
en/users/drivers/ath10k/codingstyle.1523618160.txt.gz · Last modified: 2018/04/13 11:16 by Kalle Valo