// SPDX-License-Identifier: GPL-2.0-only /* drivers/net/ethernet/micrel/ks8851.c * * Copyright 2009 Simtec Electronics * http://www.simtec.co.uk/ * Ben Dooks <[email protected]> */ #define pr_fmt(fmt) … #include <linux/interrupt.h> #include <linux/module.h> #include <linux/kernel.h> #include <linux/netdevice.h> #include <linux/etherdevice.h> #include <linux/ethtool.h> #include <linux/cache.h> #include <linux/crc32.h> #include <linux/mii.h> #include <linux/regulator/consumer.h> #include <linux/spi/spi.h> #include <linux/gpio.h> #include <linux/of_gpio.h> #include <linux/of_net.h> #include "ks8851.h" static int msg_enable; /** * struct ks8851_net_spi - KS8851 SPI driver private data * @lock: Lock to ensure that the device is not accessed when busy. * @tx_work: Work queue for tx packets * @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. * @spi_xfer1: @spi_msg1 SPI transfer structure * @spi_xfer2: @spi_msg2 SPI transfer structure * * The @lock ensures that the chip is protected when certain operations are * in progress. When the read or write packet transfer is in progress, most * of the chip registers are not ccessible until the transfer is finished and * the DMA has been de-asserted. */ struct ks8851_net_spi { … }; #define to_ks8851_spi(ks) … /* SPI frame opcodes */ #define KS_SPIOP_RD … #define KS_SPIOP_WR … #define KS_SPIOP_RXFIFO … #define KS_SPIOP_TXFIFO … /* shift for byte-enable data */ #define BYTE_EN(_x) … /* turn register number and byte-enable mask into data for start of packet */ #define MK_OP(_byteen, _reg) … /** * ks8851_lock_spi - register access lock * @ks: The chip state * @flags: Spinlock flags * * Claim chip register access lock */ static void ks8851_lock_spi(struct ks8851_net *ks, unsigned long *flags) { … } /** * ks8851_unlock_spi - register access unlock * @ks: The chip state * @flags: Spinlock flags * * Release chip register access lock */ static void ks8851_unlock_spi(struct ks8851_net *ks, unsigned long *flags) { … } /* SPI register read/write calls. * * All these calls issue SPI transactions to access the chip's registers. They * all require that the necessary lock is held to prevent accesses when the * chip is busy transferring packet data (RX/TX FIFO accesses). */ /** * ks8851_wrreg16_spi - write 16bit register value to chip via SPI * @ks: The chip state * @reg: The register address * @val: The value to write * * Issue a write to put the value @val into the register specified in @reg. */ static void ks8851_wrreg16_spi(struct ks8851_net *ks, unsigned int reg, unsigned int val) { … } /** * ks8851_rdreg - issue read register command and return the data * @ks: The device state * @op: The register address and byte enables in message format. * @rxb: The RX buffer to return the result into * @rxl: The length of data expected. * * This is the low level read call that issues the necessary spi message(s) * to read data from the register specified in @op. */ static void ks8851_rdreg(struct ks8851_net *ks, unsigned int op, u8 *rxb, unsigned int rxl) { … } /** * ks8851_rdreg16_spi - read 16 bit register from device via SPI * @ks: The chip information * @reg: The register address * * Read a 16bit register from the chip, returning the result */ static unsigned int ks8851_rdreg16_spi(struct ks8851_net *ks, unsigned int reg) { … } /** * ks8851_rdfifo_spi - read data from the receive fifo via SPI * @ks: The device state. * @buff: The buffer address * @len: The length of the data to read * * Issue an RXQ FIFO read command and read the @len amount of data from * the FIFO into the buffer specified by @buff. */ static void ks8851_rdfifo_spi(struct ks8851_net *ks, u8 *buff, unsigned int len) { … } /** * ks8851_wrfifo_spi - write packet to TX FIFO via SPI * @ks: The device state. * @txp: The sk_buff to transmit. * @irq: IRQ on completion of the packet. * * Send the @txp to the chip. This means creating the relevant packet header * specifying the length of the packet and the other information the chip * needs, such as IRQ on completion. Send the header and the packet data to * the device. */ static void ks8851_wrfifo_spi(struct ks8851_net *ks, struct sk_buff *txp, bool irq) { … } /** * calc_txlen - calculate size of message to send packet * @len: Length of data * * Returns the size of the TXFIFO message needed to send * this packet. */ static unsigned int calc_txlen(unsigned int len) { … } /** * ks8851_tx_work - process tx packet(s) * @work: The work strucutre what was scheduled. * * This is called when a number of packets have been scheduled for * transmission and need to be sent to the device. */ static void ks8851_tx_work(struct work_struct *work) { … } /** * ks8851_flush_tx_work_spi - flush outstanding TX work * @ks: The device state */ static void ks8851_flush_tx_work_spi(struct ks8851_net *ks) { … } /** * ks8851_start_xmit_spi - transmit packet using SPI * @skb: The buffer to transmit * @dev: The device used to transmit the packet. * * Called by the network layer to transmit the @skb. Queue the packet for * the device and schedule the necessary work to transmit the packet when * it is free. * * We do this to firstly avoid sleeping with the network device locked, * and secondly so we can round up more than one packet to transmit which * means we can try and avoid generating too many transmit done interrupts. */ static netdev_tx_t ks8851_start_xmit_spi(struct sk_buff *skb, struct net_device *dev) { … } static int ks8851_probe_spi(struct spi_device *spi) { … } static void ks8851_remove_spi(struct spi_device *spi) { … } static const struct of_device_id ks8851_match_table[] = …; MODULE_DEVICE_TABLE(of, ks8851_match_table); static struct spi_driver ks8851_driver = …; module_spi_driver(…) …; MODULE_DESCRIPTION(…) …; MODULE_AUTHOR(…) …; MODULE_LICENSE(…) …; module_param_named(message, msg_enable, int, 0); MODULE_PARM_DESC(…) …; MODULE_ALIAS(…) …;
Codebase Browser
linux