1

/**

     2

    Network Driver for Beckhoff CCAT communication controller

     3

    Copyright (C) 2014  Beckhoff Automation GmbH

     4

    Author: Patrick Bruenn <p.bruenn@beckhoff.com>

     5

     6

    This program is free software; you can redistribute it and/or modify

     7

    it under the terms of the GNU General Public License as published by

     8

    the Free Software Foundation; either version 2 of the License, or

     9

    (at your option) any later version.

    10

    11

    This program is distributed in the hope that it will be useful,

    12

    but WITHOUT ANY WARRANTY; without even the implied warranty of

    13

    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    14

    GNU General Public License for more details.

    15

    16

    You should have received a copy of the GNU General Public License along

    17

    with this program; if not, write to the Free Software Foundation, Inc.,

    18

    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

    19

*/

    20

    21

#ifndef _CCAT_H_

    22

#define _CCAT_H_

    23

    24

#include <linux/cdev.h>

    26

#include <linux/kernel.h>

    27

#include <linux/pci.h>

    28

#include "CCatDefinitions.h"

    29

#include "../ecdev.h"

    30

    31

#define DRV_EXTRAVERSION "-ec"

    32

#define DRV_VERSION      "0.9" DRV_EXTRAVERSION

    33

#define DRV_DESCRIPTION  "Beckhoff CCAT Ethernet/EtherCAT Network Driver"

    34

    35

#undef pr_fmt

    36

#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt

    37

    38

/**

    39

 * struct ccat_bar - CCAT PCI Base Address Register(BAR) configuration

    40

 * @start: start address of this BAR

    41

 * @end: end address of this BAR

    42

 * @len: length of this BAR

    43

 * @flags: flags set on this BAR

    44

 * @ioaddr: ioremapped address of this bar

    45

 */

    46

struct ccat_bar {

    47

	unsigned long start;

    48

	unsigned long end;

    49

	unsigned long len;

    50

	unsigned long flags;

    51

	void __iomem *ioaddr;

    52

};

    53

    54

/**

    55

 * struct ccat_dma - CCAT DMA channel configuration

    56

 * @phys: device-viewed address(physical) of the associated DMA memory

    57

 * @virt: CPU-viewed address(virtual) of the associated DMA memory

    58

 * @size: number of bytes in the associated DMA memory

    59

 * @channel: CCAT DMA channel number

    60

 * @dev: valid struct device pointer

    61

 */

    62

struct ccat_dma {

    63

	dma_addr_t phys;

    64

	void *virt;

    65

	size_t size;

    66

	size_t channel;

    67

	struct device *dev;

    68

};

    69

    70

extern void ccat_dma_free(struct ccat_dma *const dma);

    71

extern int ccat_dma_init(struct ccat_dma *const dma, size_t channel,

    72

			 void __iomem * const ioaddr, struct device *const dev);

    73

    74

/**

    75

 * struct ccat_eth_frame - Ethernet frame with DMA descriptor header in front

    76

 * @reservedn: is not used and should always be set to 0

    77

 * @received: used for reception, is set to 1 by the CCAT when data was written

    78

 * @length: number of bytes in the frame including the DMA header

    79

 * @sent: is set to 1 by the CCAT when data was transmitted

    80

 * @timestamp: a 64 bit EtherCAT timestamp

    81

 * @data: the bytes of the ethernet frame

    82

 */

    83

struct ccat_eth_frame {

    93

};

    94

    95

/**

    96

 * struct ccat_eth_register - CCAT register addresses in the PCI BAR

    97

 * @mii: address of the CCAT management interface register

    98

 * @tx_fifo: address of the CCAT TX DMA fifo register

    99

 * @rx_fifo: address of the CCAT RX DMA fifo register

   100

 * @mac: address of the CCAT media access control register

   101

 * @rx_mem: address of the CCAT register holding the RX DMA address

   102

 * @tx_mem: address of the CCAT register holding the TX DMA address

   103

 * @misc: address of a CCAT register holding miscellaneous information

   104

 */

   105

struct ccat_eth_register {

   106

	void __iomem *mii;

   107

	void __iomem *tx_fifo;

   108

	void __iomem *rx_fifo;

   109

	void __iomem *mac;

   110

	void __iomem *rx_mem;

   111

	void __iomem *tx_mem;

   112

	void __iomem *misc;

   113

};

   114

   115

/**

   116

 * struct ccat_eth_dma_fifo - CCAT RX or TX DMA fifo

   117

 * @add: callback used to add a frame to this fifo

   118

 * @reg: PCI register address of this DMA fifo

   119

 * @dma: information about the associated DMA memory

   120

 */

   121

struct ccat_eth_dma_fifo {

   122

	void (*add) (struct ccat_eth_frame *, struct ccat_eth_dma_fifo *);

   123

	void __iomem *reg;

   124

	struct ccat_dma dma;

   125

};

   126

   127

/**

   128

 * struct ccat_device - CCAT device representation

   129

 * @pdev: pointer to the pci object allocated by the kernel

   130

 * @ethdev: CCAT Ethernet/EtherCAT Master (with DMA) function, NULL if function is not available or failed to initialize

   131

 * @update: CCAT Update function, NULL if function is not available or failed to initialize

   132

 * @bar [0] and [2] holding information about PCI BARs 0 and 2.

   133

 *

   134

 * One instance of a ccat_device should represent a physical CCAT. Since

   135

 * a CCAT is implemented as FPGA the available functions can vary so

   136

 * the function object pointers can be NULL.

   137

 * Extra note: you will recognize that PCI BAR1 is not used and is a

   138

 * waste of memory, thats true but right now, its very easy to use it

   139

 * this way. So we might optimize it later.

   140

 */

   141

struct ccat_device {

   142

	struct pci_dev *pdev;

   143

	struct ccat_eth_priv *ethdev;

   144

	struct ccat_update *update;

   145

	struct ccat_bar bar[3];	//TODO optimize this

   146

};

   147

   148

/**

   149

 * struct ccat_eth_priv - CCAT Ethernet/EtherCAT Master function (netdev)

   150

 * @ccatdev: pointer to the parent struct ccat_device

   151

 * @netdev: the net_device structure used by the kernel networking stack

   152

 * @next_tx_frame: pointer to the next TX DMA descriptor, which the tx_thread should check for availablity

   153

 * @info: holds a copy of the CCAT Ethernet/EtherCAT Master function information block (read from PCI config space)

   154

 * @reg: register addresses in PCI config space of the Ethernet/EtherCAT Master function

   155

 * @rx_fifo: DMA fifo used for RX DMA descriptors

   156

 * @tx_fifo: DMA fifo used for TX DMA descriptors

   158

 * @rx_bytes: number of bytes received -> reported with ndo_get_stats64()

   159

 * @rx_dropped: number of received frames, which were dropped -> reported with ndo_get_stats64()

   160

 * @tx_bytes: number of bytes send -> reported with ndo_get_stats64()

   161

 * @tx_dropped: number of frames requested to send, which were dropped -> reported with ndo_get_stats64()

   162

 */

   163

struct ccat_eth_priv {

   164

	const struct ccat_device *ccatdev;

   165

	struct net_device *netdev;

   167

	CCatInfoBlock info;

   168

	struct ccat_eth_register reg;

   169

	struct ccat_eth_dma_fifo rx_fifo;

   170

	struct ccat_eth_dma_fifo tx_fifo;

   172

	atomic64_t rx_bytes;

   173

	atomic64_t rx_dropped;

   174

	atomic64_t tx_bytes;

   175

	atomic64_t tx_dropped;

   176

	ec_device_t *ecdev;

   177

	void (*carrier_off) (struct net_device * const netdev);

   179

	void (*carrier_on) (struct net_device * const netdev);

   180

	void (*kfree_skb_any) (struct sk_buff * skb);

   181

	void (*start_queue) (struct net_device * const netdev);

   182

	void (*stop_queue) (struct net_device * const netdev);

   184

			      const struct ccat_eth_frame * const frame);

   185

	void (*unregister) (struct net_device * const netdev);

   186

};

   187

   188

/**

   189

 * struct ccat_update - CCAT Update function (update)

   190

 * @ccatdev: pointer to the parent struct ccat_device

   191

 * @ioaddr: PCI base address of the CCAT Update function

   192

 * dev: device number for this update function

   193

 * cdev: character device used for the CCAT Update function

   194

 * class: pointer to a device class used when registering the CCAT Update device

   195

 * @info: holds a copy of the CCAT Update function information block (read from PCI config space)

   196

 */

   197

struct ccat_update {

   198

	struct kref refcount;

   199

	void __iomem *ioaddr;

   200

	dev_t dev;

   201

	struct cdev cdev;

   202

	struct class *class;

   203

	CCatInfoBlock info;

   204

};

   205

#endif /* #ifndef _CCAT_H_ */