Commit eb97b9bd authored by Radu Pirea (NXP OSS)'s avatar Radu Pirea (NXP OSS) Committed by David S. Miller
Browse files

net: macsec: documentation for macsec_context and macsec_ops 



Add description for fields of struct macsec_context and struct
macsec_ops.

Signed-off-by: default avatarRadu Pirea (NXP OSS) <radu-nicolae.pirea@oss.nxp.com>
Signed-off-by: default avatarDavid S. Miller <davem@davemloft.net>
parent b1c036e8

include/net/macsec.h

+39 −0
Original line number Diff line number Diff line
@@ -247,6 +247,23 @@ struct macsec_secy { 


/**

 * struct macsec_context - MACsec context for hardware offloading

 * @netdev: a valid pointer to a struct net_device if @offload ==

 *	MACSEC_OFFLOAD_MAC

 * @phydev: a valid pointer to a struct phy_device if @offload ==

 *	MACSEC_OFFLOAD_PHY

 * @offload: MACsec offload status

 * @secy: pointer to a MACsec SecY

 * @rx_sc: pointer to a RX SC

 * @update_pn: when updating the SA, update the next PN

 * @assoc_num: association number of the target SA

 * @key: key of the target SA

 * @rx_sa: pointer to an RX SA if a RX SA is added/updated/removed

 * @tx_sa: pointer to an TX SA if a TX SA is added/updated/removed

 * @tx_sc_stats: pointer to TX SC stats structure

 * @tx_sa_stats: pointer to TX SA stats structure

 * @rx_sc_stats: pointer to RX SC stats structure

 * @rx_sa_stats: pointer to RX SA stats structure

 * @dev_stats: pointer to dev stats structure

 */

struct macsec_context {

	union {
@@ -277,6 +294,28 @@ struct macsec_context { 


/**

 * struct macsec_ops - MACsec offloading operations

 * @mdo_dev_open: called when the MACsec interface transitions to the up state

 * @mdo_dev_stop: called when the MACsec interface transitions to the down

 *	state

 * @mdo_add_secy: called when a new SecY is added

 * @mdo_upd_secy: called when the SecY flags are changed or the MAC address of

 *	the MACsec interface is changed

 * @mdo_del_secy: called when the hw offload is disabled or the MACsec

 *	interface is removed

 * @mdo_add_rxsc: called when a new RX SC is added

 * @mdo_upd_rxsc: called when a certain RX SC is updated

 * @mdo_del_rxsc: called when a certain RX SC is removed

 * @mdo_add_rxsa: called when a new RX SA is added

 * @mdo_upd_rxsa: called when a certain RX SA is updated

 * @mdo_del_rxsa: called when a certain RX SA is removed

 * @mdo_add_txsa: called when a new TX SA is added

 * @mdo_upd_txsa: called when a certain TX SA is updated

 * @mdo_del_txsa: called when a certain TX SA is removed

 * @mdo_get_dev_stats: called when dev stats are read

 * @mdo_get_tx_sc_stats: called when TX SC stats are read

 * @mdo_get_tx_sa_stats: called when TX SA stats are read

 * @mdo_get_rx_sc_stats: called when RX SC stats are read

 * @mdo_get_rx_sa_stats: called when RX SA stats are read

 */

struct macsec_ops {

	/* Device wide */