diff mbox series

[09/14] net: ks8851: Split out SPI specific entries in struct ks8851_net

Message ID 20200323234303.526748-10-marex@denx.de
State Superseded
Delegated to: David Miller
Headers show
Series net: ks8851: Unify KS8851 SPI and MLL drivers | expand

Commit Message

Marek Vasut March 23, 2020, 11:42 p.m. UTC 
Add a new struct ks8851_net_spi, which embeds the original
struct ks8851_net and contains the entries specific only to
the SPI variant of KS8851.

There should be no functional change.

Signed-off-by: Marek Vasut <marex@denx.de>
Cc: David S. Miller <davem@davemloft.net>
Cc: Lukas Wunner <lukas@wunner.de>
Cc: Petr Stetiar <ynezz@true.cz>
Cc: YueHaibing <yuehaibing@huawei.com>
---
 drivers/net/ethernet/micrel/ks8851.c | 76 +++++++++++++++++-----------
 1 file changed, 47 insertions(+), 29 deletions(-)

Comments

Andrew Lunn March 24, 2020, 1:55 a.m. UTC | #1 
> + * struct ks8851_net_spi - KS8851 SPI driver private data
> + * @ks8851: KS8851 driver common private data
> + * @spidev: The spi device we're bound to.
> + * @spi_msg1: pre-setup SPI transfer with one message, @spi_xfer1.
> + * @spi_msg2: pre-setup SPI transfer with two messages, @spi_xfer2.
> + */
> +struct ks8851_net_spi {
> +	struct ks8851_net	ks8851;	/* Must be first */
> +	struct spi_device	*spidev;
> +	struct spi_message	spi_msg1;
> +	struct spi_message	spi_msg2;
> +	struct spi_transfer	spi_xfer1;
> +	struct spi_transfer	spi_xfer2[2];
> +};
> +
> +#define to_ks8851_spi(ks) container_of((ks), struct ks8851_net_spi, ks8851)

Since you are using container_of(), ks8851 does not need to be first.

      Andrew
Lukas Wunner March 24, 2020, 10:49 a.m. UTC | #2 
On Tue, Mar 24, 2020 at 12:42:58AM +0100, Marek Vasut wrote:
> +/**
> + * struct ks8851_net_spi - KS8851 SPI driver private data
> + * @ks8851: KS8851 driver common private data
> + * @spidev: The spi device we're bound to.
> + * @spi_msg1: pre-setup SPI transfer with one message, @spi_xfer1.
> + * @spi_msg2: pre-setup SPI transfer with two messages, @spi_xfer2.

You need to remove these kerneldoc entries further up from struct ks8851_net.


> +struct ks8851_net_spi {
> +	struct ks8851_net	ks8851;	/* Must be first */
> +	struct spi_device	*spidev;
> +	struct spi_message	spi_msg1;
> +	struct spi_message	spi_msg2;
> +	struct spi_transfer	spi_xfer1;
> +	struct spi_transfer	spi_xfer2[2];
> +};
> +
> +#define to_ks8851_spi(ks) container_of((ks), struct ks8851_net_spi, ks8851)

Since it's always the first entry in the struct, a cast instead of
container_of() would seem to be sufficient.

Thanks,

Lukas
Andrew Lunn March 24, 2020, 12:27 p.m. UTC | #3 
On Tue, Mar 24, 2020 at 11:49:19AM +0100, Lukas Wunner wrote:
> On Tue, Mar 24, 2020 at 12:42:58AM +0100, Marek Vasut wrote:
> > +/**
> > + * struct ks8851_net_spi - KS8851 SPI driver private data
> > + * @ks8851: KS8851 driver common private data
> > + * @spidev: The spi device we're bound to.
> > + * @spi_msg1: pre-setup SPI transfer with one message, @spi_xfer1.
> > + * @spi_msg2: pre-setup SPI transfer with two messages, @spi_xfer2.
> 
> You need to remove these kerneldoc entries further up from struct ks8851_net.
> 
> 
> > +struct ks8851_net_spi {
> > +	struct ks8851_net	ks8851;	/* Must be first */
> > +	struct spi_device	*spidev;
> > +	struct spi_message	spi_msg1;
> > +	struct spi_message	spi_msg2;
> > +	struct spi_transfer	spi_xfer1;
> > +	struct spi_transfer	spi_xfer2[2];
> > +};
> > +
> > +#define to_ks8851_spi(ks) container_of((ks), struct ks8851_net_spi, ks8851)
> 
> Since it's always the first entry in the struct, a cast instead of
> container_of() would seem to be sufficient.

Hi Lukus

That is bad practice. container_of() will always get it correct,
making it safer.

       Andrew
diff mbox series

Patch

diff --git a/drivers/net/ethernet/micrel/ks8851.c b/drivers/net/ethernet/micrel/ks8851.c
index 03d349208794..56f505ae6458 100644
--- a/drivers/net/ethernet/micrel/ks8851.c
+++ b/drivers/net/ethernet/micrel/ks8851.c
@@ -102,7 +102,6 @@  union ks8851_tx_hdr {
  */
 struct ks8851_net {
 	struct net_device	*netdev;
-	struct spi_device	*spidev;
 	struct mutex		lock;
 	spinlock_t		statelock;
 
@@ -126,17 +125,30 @@  struct ks8851_net {
 
 	struct sk_buff_head	txq;
 
-	struct spi_message	spi_msg1;
-	struct spi_message	spi_msg2;
-	struct spi_transfer	spi_xfer1;
-	struct spi_transfer	spi_xfer2[2];
-
 	struct eeprom_93cx6	eeprom;
 	struct regulator	*vdd_reg;
 	struct regulator	*vdd_io;
 	int			gpio;
 };
 
+/**
+ * struct ks8851_net_spi - KS8851 SPI driver private data
+ * @ks8851: KS8851 driver common private data
+ * @spidev: The spi device we're bound to.
+ * @spi_msg1: pre-setup SPI transfer with one message, @spi_xfer1.
+ * @spi_msg2: pre-setup SPI transfer with two messages, @spi_xfer2.
+ */
+struct ks8851_net_spi {
+	struct ks8851_net	ks8851;	/* Must be first */
+	struct spi_device	*spidev;
+	struct spi_message	spi_msg1;
+	struct spi_message	spi_msg2;
+	struct spi_transfer	spi_xfer1;
+	struct spi_transfer	spi_xfer2[2];
+};
+
+#define to_ks8851_spi(ks) container_of((ks), struct ks8851_net_spi, ks8851)
+
 static int msg_enable;
 
 /* SPI frame opcodes */
@@ -168,8 +180,9 @@  static int msg_enable;
  */
 static void ks8851_wrreg16(struct ks8851_net *ks, unsigned reg, unsigned val)
 {
-	struct spi_transfer *xfer = &ks->spi_xfer1;
-	struct spi_message *msg = &ks->spi_msg1;
+	struct ks8851_net_spi *kss = to_ks8851_spi(ks);
+	struct spi_transfer *xfer = &kss->spi_xfer1;
+	struct spi_message *msg = &kss->spi_msg1;
 	__le16 txb[2];
 	int ret;
 
@@ -180,7 +193,7 @@  static void ks8851_wrreg16(struct ks8851_net *ks, unsigned reg, unsigned val)
 	xfer->rx_buf = NULL;
 	xfer->len = 4;
 
-	ret = spi_sync(ks->spidev, msg);
+	ret = spi_sync(kss->spidev, msg);
 	if (ret < 0)
 		netdev_err(ks->netdev, "spi_sync() failed\n");
 }
@@ -198,6 +211,7 @@  static void ks8851_wrreg16(struct ks8851_net *ks, unsigned reg, unsigned val)
 static void ks8851_rdreg(struct ks8851_net *ks, unsigned op,
 			 u8 *rxb, unsigned rxl)
 {
+	struct ks8851_net_spi *kss = to_ks8851_spi(ks);
 	struct spi_transfer *xfer;
 	struct spi_message *msg;
 	__le16 *txb = (__le16 *)ks->txd;
@@ -206,9 +220,9 @@  static void ks8851_rdreg(struct ks8851_net *ks, unsigned op,
 
 	txb[0] = cpu_to_le16(op | KS_SPIOP_RD);
 
-	if (ks->spidev->master->flags & SPI_MASTER_HALF_DUPLEX) {
-		msg = &ks->spi_msg2;
-		xfer = ks->spi_xfer2;
+	if (kss->spidev->master->flags & SPI_MASTER_HALF_DUPLEX) {
+		msg = &kss->spi_msg2;
+		xfer = kss->spi_xfer2;
 
 		xfer->tx_buf = txb;
 		xfer->rx_buf = NULL;
@@ -219,18 +233,18 @@  static void ks8851_rdreg(struct ks8851_net *ks, unsigned op,
 		xfer->rx_buf = trx;
 		xfer->len = rxl;
 	} else {
-		msg = &ks->spi_msg1;
-		xfer = &ks->spi_xfer1;
+		msg = &kss->spi_msg1;
+		xfer = &kss->spi_xfer1;
 
 		xfer->tx_buf = txb;
 		xfer->rx_buf = trx;
 		xfer->len = rxl + 2;
 	}
 
-	ret = spi_sync(ks->spidev, msg);
+	ret = spi_sync(kss->spidev, msg);
 	if (ret < 0)
 		netdev_err(ks->netdev, "read: spi_sync() failed\n");
-	else if (ks->spidev->master->flags & SPI_MASTER_HALF_DUPLEX)
+	else if (kss->spidev->master->flags & SPI_MASTER_HALF_DUPLEX)
 		memcpy(rxb, trx, rxl);
 	else
 		memcpy(rxb, trx + 2, rxl);
@@ -398,8 +412,9 @@  static void ks8851_init_mac(struct ks8851_net *ks, struct device *ddev)
  */
 static void ks8851_rdfifo(struct ks8851_net *ks, u8 *buff, unsigned len)
 {
-	struct spi_transfer *xfer = ks->spi_xfer2;
-	struct spi_message *msg = &ks->spi_msg2;
+	struct ks8851_net_spi *kss = to_ks8851_spi(ks);
+	struct spi_transfer *xfer = kss->spi_xfer2;
+	struct spi_message *msg = &kss->spi_msg2;
 	u8 txb[1];
 	int ret;
 
@@ -418,7 +433,7 @@  static void ks8851_rdfifo(struct ks8851_net *ks, u8 *buff, unsigned len)
 	xfer->tx_buf = NULL;
 	xfer->len = len;
 
-	ret = spi_sync(ks->spidev, msg);
+	ret = spi_sync(kss->spidev, msg);
 	if (ret < 0)
 		netdev_err(ks->netdev, "%s: spi_sync() failed\n", __func__);
 }
@@ -642,8 +657,9 @@  static inline unsigned calc_txlen(unsigned len)
  */
 static void ks8851_wrpkt(struct ks8851_net *ks, struct sk_buff *txp, bool irq)
 {
-	struct spi_transfer *xfer = ks->spi_xfer2;
-	struct spi_message *msg = &ks->spi_msg2;
+	struct ks8851_net_spi *kss = to_ks8851_spi(ks);
+	struct spi_transfer *xfer = kss->spi_xfer2;
+	struct spi_message *msg = &kss->spi_msg2;
 	unsigned fid = 0;
 	int ret;
 
@@ -670,7 +686,7 @@  static void ks8851_wrpkt(struct ks8851_net *ks, struct sk_buff *txp, bool irq)
 	xfer->rx_buf = NULL;
 	xfer->len = ALIGN(txp->len, 4);
 
-	ret = spi_sync(ks->spidev, msg);
+	ret = spi_sync(kss->spidev, msg);
 	if (ret < 0)
 		netdev_err(ks->netdev, "%s: spi_sync() failed\n", __func__);
 }
@@ -1358,22 +1374,24 @@  static SIMPLE_DEV_PM_OPS(ks8851_pm_ops, ks8851_suspend, ks8851_resume);
 static int ks8851_probe(struct spi_device *spi)
 {
 	struct device *dev = &spi->dev;
+	struct ks8851_net_spi *kss;
 	struct net_device *ndev;
 	struct ks8851_net *ks;
 	int ret;
 	unsigned cider;
 	int gpio;
 
-	ndev = devm_alloc_etherdev(dev, sizeof(struct ks8851_net));
+	ndev = devm_alloc_etherdev(dev, sizeof(struct ks8851_net_spi));
 	if (!ndev)
 		return -ENOMEM;
 
 	spi->bits_per_word = 8;
 
 	ks = netdev_priv(ndev);
+	kss = to_ks8851_spi(ks);
 
 	ks->netdev = ndev;
-	ks->spidev = spi;
+	kss->spidev = spi;
 	ks->tx_space = 6144;
 
 	gpio = of_get_named_gpio_flags(dev->of_node, "reset-gpios",
@@ -1430,12 +1448,12 @@  static int ks8851_probe(struct spi_device *spi)
 
 	/* initialise pre-made spi transfer messages */
 
-	spi_message_init(&ks->spi_msg1);
-	spi_message_add_tail(&ks->spi_xfer1, &ks->spi_msg1);
+	spi_message_init(&kss->spi_msg1);
+	spi_message_add_tail(&kss->spi_xfer1, &kss->spi_msg1);
 
-	spi_message_init(&ks->spi_msg2);
-	spi_message_add_tail(&ks->spi_xfer2[0], &ks->spi_msg2);
-	spi_message_add_tail(&ks->spi_xfer2[1], &ks->spi_msg2);
+	spi_message_init(&kss->spi_msg2);
+	spi_message_add_tail(&kss->spi_xfer2[0], &kss->spi_msg2);
+	spi_message_add_tail(&kss->spi_xfer2[1], &kss->spi_msg2);
 
 	/* setup EEPROM state */