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>

    25

#include <linux/fs.h>

    26

#include <linux/hrtimer.h>

    27

#include <linux/kernel.h>

    28

#include <linux/pci.h>

    29

#include "../ecdev.h"

    30

    31

#define DRV_EXTRAVERSION "-ec"

    32

#define DRV_VERSION      "0.14" 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

extern const struct ccat_driver eth_eim_driver;

    39

extern const struct ccat_driver eth_dma_driver;

    40

extern const struct ccat_driver gpio_driver;

    41

extern const struct ccat_driver sram_driver;

    42

extern const struct ccat_driver update_driver;

    43

    44

/**

    45

 * CCAT function type identifiers (u16)

    46

 */

    47

enum ccat_info_t {

    48

	CCATINFO_NOTUSED = 0,

    49

	CCATINFO_ETHERCAT_NODMA = 0x3,

    50

	CCATINFO_GPIO = 0xd,

    51

	CCATINFO_EPCS_PROM = 0xf,

    52

	CCATINFO_ETHERCAT_MASTER_DMA = 0x14,

    53

	CCATINFO_SRAM = 0x16,

    54

};

    55

    56

struct ccat_cdev {

    57

	atomic_t in_use;

    58

	void __iomem *ioaddr;

    59

	size_t iosize;

    60

	dev_t dev;

    61

	struct cdev cdev;

    62

	struct ccat_class *class;

    63

};

    64

    65

/**

    66

 * struct cdev_buffer

    67

 * @ccdev: referenced character device

    68

 * @data: buffer used for write operations

    69

 * @size: number of bytes written to the data buffer

    70

 */

    71

struct cdev_buffer {

    72

	struct ccat_cdev *ccdev;

    73

	size_t size;

    74

	char data[];

    75

};

    76

    77

extern int ccat_cdev_open(struct inode *const i, struct file *const f);

    78

extern int ccat_cdev_release(struct inode *const i, struct file *const f);

    79

    80

/**

    81

 * struct ccat_device - CCAT device representation

    82

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

    83

 * @bar_0: holding information about PCI BAR 0

    84

 * @bar_2: holding information about PCI BAR 2 (optional)

    85

 * @functions: list of available (driver loaded) FPGA functions

    86

 *

    87

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

    88

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

    89

 */

    90

struct ccat_device {

    91

	void *pdev;

    92

	void __iomem *bar_0;

    93

	void __iomem *bar_2;

    94

	struct list_head functions;

    95

};

    96

    97

struct ccat_info_block {

    98

	u16 type;

    99

	u16 rev;

   100

	union {

   101

		u32 config;

   102

		u8 num_gpios;

   103

		struct {

   104

			u16 tx_size;

   105

			u16 rx_size;

   106

		};

   107

		struct {

   108

			u8 tx_dma_chan;

   109

			u8 rx_dma_chan;

   110

		};

   111

		struct {

   112

			u8 sram_width;

   113

			u8 sram_size;

   114

			u16 reserved;

   115

		};

   116

	};

   117

	u32 addr;

   118

	u32 size;

   119

};

   120

   121

struct ccat_function {

   122

	const struct ccat_driver *drv;

   123

	struct ccat_device *ccat;

   124

	struct ccat_info_block info;

   125

	struct list_head list;

   126

	void *private_data;

   127

};

   128

   129

struct ccat_class {

   130

	dev_t dev;

   131

	struct class *class;

   132

	atomic_t instances;

   133

	const unsigned count;

   134

	struct ccat_cdev *devices;

   135

	const char *name;

   136

	struct file_operations fops;

   137

};

   138

   139

extern void ccat_cdev_remove(struct ccat_function *func);

   140

extern int ccat_cdev_probe(struct ccat_function *func,

   141

			   struct ccat_class *cdev_class, size_t iosize);

   142

   143

/**

   144

 * struct ccat_driver - CCAT FPGA function

   145

 * @probe: add device instance

   146

 * @remove: remove device instance

   147

 * @type: type of the FPGA function supported by this driver

   148

 * @cdev_class: if not NULL that driver supports ccat_class_init()/_exit()

   149

 */

   150

struct ccat_driver {

   151

	int (*probe) (struct ccat_function * func);

   152

	void (*remove) (struct ccat_function * drv);

   153

	enum ccat_info_t type;

   154

	struct ccat_class *cdev_class;

   155

};

   156

   157

#endif /* #ifndef _CCAT_H_ */