Skip to content

Commit eb97b9b

Browse files
Radu Pirea (NXP OSS)davem330
authored andcommitted
net: macsec: documentation for macsec_context and macsec_ops
Add description for fields of struct macsec_context and struct macsec_ops. Signed-off-by: Radu Pirea (NXP OSS) <[email protected]> Signed-off-by: David S. Miller <[email protected]>
1 parent b1c036e commit eb97b9b

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

include/net/macsec.h

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -247,6 +247,23 @@ struct macsec_secy {
247247

248248
/**
249249
* struct macsec_context - MACsec context for hardware offloading
250+
* @netdev: a valid pointer to a struct net_device if @offload ==
251+
* MACSEC_OFFLOAD_MAC
252+
* @phydev: a valid pointer to a struct phy_device if @offload ==
253+
* MACSEC_OFFLOAD_PHY
254+
* @offload: MACsec offload status
255+
* @secy: pointer to a MACsec SecY
256+
* @rx_sc: pointer to a RX SC
257+
* @update_pn: when updating the SA, update the next PN
258+
* @assoc_num: association number of the target SA
259+
* @key: key of the target SA
260+
* @rx_sa: pointer to an RX SA if a RX SA is added/updated/removed
261+
* @tx_sa: pointer to an TX SA if a TX SA is added/updated/removed
262+
* @tx_sc_stats: pointer to TX SC stats structure
263+
* @tx_sa_stats: pointer to TX SA stats structure
264+
* @rx_sc_stats: pointer to RX SC stats structure
265+
* @rx_sa_stats: pointer to RX SA stats structure
266+
* @dev_stats: pointer to dev stats structure
250267
*/
251268
struct macsec_context {
252269
union {
@@ -277,6 +294,28 @@ struct macsec_context {
277294

278295
/**
279296
* struct macsec_ops - MACsec offloading operations
297+
* @mdo_dev_open: called when the MACsec interface transitions to the up state
298+
* @mdo_dev_stop: called when the MACsec interface transitions to the down
299+
* state
300+
* @mdo_add_secy: called when a new SecY is added
301+
* @mdo_upd_secy: called when the SecY flags are changed or the MAC address of
302+
* the MACsec interface is changed
303+
* @mdo_del_secy: called when the hw offload is disabled or the MACsec
304+
* interface is removed
305+
* @mdo_add_rxsc: called when a new RX SC is added
306+
* @mdo_upd_rxsc: called when a certain RX SC is updated
307+
* @mdo_del_rxsc: called when a certain RX SC is removed
308+
* @mdo_add_rxsa: called when a new RX SA is added
309+
* @mdo_upd_rxsa: called when a certain RX SA is updated
310+
* @mdo_del_rxsa: called when a certain RX SA is removed
311+
* @mdo_add_txsa: called when a new TX SA is added
312+
* @mdo_upd_txsa: called when a certain TX SA is updated
313+
* @mdo_del_txsa: called when a certain TX SA is removed
314+
* @mdo_get_dev_stats: called when dev stats are read
315+
* @mdo_get_tx_sc_stats: called when TX SC stats are read
316+
* @mdo_get_tx_sa_stats: called when TX SA stats are read
317+
* @mdo_get_rx_sc_stats: called when RX SC stats are read
318+
* @mdo_get_rx_sa_stats: called when RX SA stats are read
280319
*/
281320
struct macsec_ops {
282321
/* Device wide */

0 commit comments

Comments
 (0)