1

/**

     2

    Network Driver for Beckhoff CCAT communication controller

     3

    Copyright (C) 2014-2015  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

#include <linux/etherdevice.h>

    22

#include <linux/module.h>

    23

#include <linux/netdevice.h>

    24

#include <linux/platform_device.h>

    25

#include <linux/version.h>

    26

    27

#include "module.h"

    28

    29

MODULE_DESCRIPTION(DRV_DESCRIPTION);

    30

MODULE_AUTHOR("Patrick Bruenn <p.bruenn@beckhoff.com>");

    31

MODULE_LICENSE("GPL");

    32

MODULE_VERSION(DRV_VERSION);

    33

    34

#if (LINUX_VERSION_CODE < KERNEL_VERSION(3,12,27))

    35

/*

    36

 * Set both the DMA mask and the coherent DMA mask to the same thing.

    37

 * Note that we don't check the return value from dma_set_coherent_mask()

    38

 * as the DMA API guarantees that the coherent DMA mask can be set to

    39

 * the same or smaller than the streaming DMA mask.

    40

 */

    41

static inline int dma_set_mask_and_coherent(struct device *dev, u64 mask)

    42

{

    43

	int rc = dma_set_mask(dev, mask);

    44

	if (rc == 0)

    45

		dma_set_coherent_mask(dev, mask);

    46

	return rc;

    47

}

    48

#endif

    49

    50

/**

    51

 * configure the drivers capabilities here

    52

 */

    53

static const struct ccat_driver *const drivers[] = {

    54

#ifdef CONFIG_PCI

    55

	&eth_dma_driver,	/* load Ethernet MAC/EtherCAT Master driver with DMA support from netdev.c */

    56

#endif

    57

	&eth_eim_driver,	/* load Ethernet MAC/EtherCAT Master driver without DMA support from */

    58

	&gpio_driver,		/* load GPIO driver from gpio.c */

    59

	&sram_driver,		/* load SRAM driver from sram.c */

    60

	&update_driver,		/* load Update driver from update.c */

    61

};

    62

    63

static int __init ccat_class_init(struct ccat_class *base)

    64

{

    65

	if (1 == atomic_inc_return(&base->instances)) {

    66

		if (alloc_chrdev_region

    67

		    (&base->dev, 0, base->count, KBUILD_MODNAME)) {

    68

			pr_warn("alloc_chrdev_region() for '%s' failed\n",

    69

				base->name);

    70

			return -1;

    71

		}

    72

    73

		base->class = class_create(THIS_MODULE, base->name);

    74

		if (!base->class) {

    75

			pr_warn("Create device class '%s' failed\n",

    76

				base->name);

    77

			unregister_chrdev_region(base->dev, base->count);

    78

			return -1;

    79

		}

    80

	}

    81

	return 0;

    82

}

    83

    84

static void ccat_class_exit(struct ccat_class *base)

    85

{

    86

	if (!atomic_dec_return(&base->instances)) {

    87

		class_destroy(base->class);

    88

		unregister_chrdev_region(base->dev, base->count);

    89

	}

    90

}

    91

    92

static void free_ccat_cdev(struct ccat_cdev *ccdev)

    93

{

    94

	ccat_class_exit(ccdev->class);

    95

	ccdev->dev = 0;

    96

}

    97

    98

static struct ccat_cdev *alloc_ccat_cdev(struct ccat_class *base)

    99

{

   100

	int i = 0;

   101

   102

	ccat_class_init(base);

   103

	for (i = 0; i < base->count; ++i) {

   104

		if (base->devices[i].dev == 0) {

   105

			base->devices[i].dev = MKDEV(MAJOR(base->dev), i);

   106

			return &base->devices[i];

   107

		}

   108

	}

   109

	pr_warn("exceeding max. number of '%s' devices (%d)\n",

   110

		base->class->name, base->count);

   111

	atomic_dec_return(&base->instances);

   112

	return NULL;

   113

}

   114

   115

static int ccat_cdev_init(struct cdev *cdev, dev_t dev, struct class *class,

   116

			  struct file_operations *fops)

   117

{

   118

	if (!device_create

   119

	    (class, NULL, dev, NULL, "%s%d", class->name, MINOR(dev))) {

   120

		pr_warn("device_create() failed\n");

   121

		return -1;

   122

	}

   123

   124

	cdev_init(cdev, fops);

   125

	cdev->owner = fops->owner;

   126

	if (cdev_add(cdev, dev, 1)) {

   127

		pr_warn("add update device failed\n");

   128

		device_destroy(class, dev);

   129

		return -1;

   130

	}

   131

   132

	pr_info("registered %s%d.\n", class->name, MINOR(dev));

   133

	return 0;

   134

}

   135

   136

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

   137

{

   138

	struct ccat_cdev *ccdev =

   139

	    container_of(i->i_cdev, struct ccat_cdev, cdev);

   140

	struct cdev_buffer *buf;

   141

   142

	if (!atomic_dec_and_test(&ccdev->in_use)) {

   143

		atomic_inc(&ccdev->in_use);

   144

		return -EBUSY;

   145

	}

   146

   147

	buf = kzalloc(sizeof(*buf) + ccdev->iosize, GFP_KERNEL);

   148

	if (!buf) {

   149

		atomic_inc(&ccdev->in_use);

   150

		return -ENOMEM;

   151

	}

   152

   153

	buf->ccdev = ccdev;

   154

	f->private_data = buf;

   155

	return 0;

   156

}

   157

   158

int ccat_cdev_probe(struct ccat_function *func, struct ccat_class *cdev_class,

   159

		    size_t iosize)

   160

{

   161

	struct ccat_cdev *const ccdev = alloc_ccat_cdev(cdev_class);

   162

	if (!ccdev) {

   163

		return -ENOMEM;

   164

	}

   165

   166

	ccdev->ioaddr = func->ccat->bar_0 + func->info.addr;

   167

	ccdev->iosize = iosize;

   168

	atomic_set(&ccdev->in_use, 1);

   169

   170

	if (ccat_cdev_init

   171

	    (&ccdev->cdev, ccdev->dev, cdev_class->class, &cdev_class->fops)) {

   172

		pr_warn("ccat_cdev_probe() failed\n");

   173

		free_ccat_cdev(ccdev);

   174

		return -1;

   175

	}

   176

	ccdev->class = cdev_class;

   177

	func->private_data = ccdev;

   178

	return 0;

   179

}

   180

   181

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

   182

{

   183

	const struct cdev_buffer *const buf = f->private_data;

   184

	struct ccat_cdev *const ccdev = buf->ccdev;

   185

   186

	kfree(f->private_data);

   187

	atomic_inc(&ccdev->in_use);

   188

	return 0;

   189

}

   190

   191

void ccat_cdev_remove(struct ccat_function *func)

   192

{

   193

	struct ccat_cdev *const ccdev = func->private_data;

   194

   195

	cdev_del(&ccdev->cdev);

   196

	device_destroy(ccdev->class->class, ccdev->dev);

   197

	free_ccat_cdev(ccdev);

   198

}

   199

   200

static const struct ccat_driver *ccat_function_connect(struct ccat_function

   201

						       *const func)

   202

{

   203

	int i;

   204

   205

	for (i = 0; i < ARRAY_SIZE(drivers); ++i) {

   206

		if (func->info.type == drivers[i]->type) {

   207

			return drivers[i]->probe(func) ? NULL : drivers[i];

   208

		}

   209

	}

   210

	return NULL;

   211

}

   212

   213

/**

   214

 * Initialize all available CCAT functions.

   215

 *

   216

 * Return: count of failed functions

   217

 */

   218

static int ccat_functions_init(struct ccat_device *const ccatdev)

   219

{

   220

	static const size_t block_size = sizeof(struct ccat_info_block);

   221

	struct ccat_function *next = kzalloc(sizeof(*next), GFP_KERNEL);

   222

	void __iomem *addr = ccatdev->bar_0; /** first block is the CCAT information block entry */

   223

	const u8 num_func = ioread8(addr + 4); /** number of CCAT function blocks is at offset 0x4 */

   224

	const void __iomem *end = addr + (block_size * num_func);

   225

   226

	INIT_LIST_HEAD(&ccatdev->functions);

   227

	for (; addr < end && next; addr += block_size) {

   228

		memcpy_fromio(&next->info, addr, sizeof(next->info));

   229

		if (CCATINFO_NOTUSED != next->info.type) {

   230

			next->ccat = ccatdev;

   231

			next->drv = ccat_function_connect(next);

   232

			if (next->drv) {

   233

				list_add(&next->list, &ccatdev->functions);

   234

				next = kzalloc(sizeof(*next), GFP_KERNEL);

   235

			}

   236

		}

   237

	}

   238

	kfree(next);

   239

	return list_empty(&ccatdev->functions);

   240

}

   241

   242

/**

   243

 * Destroy all previously initialized CCAT functions

   244

 */

   245

static void ccat_functions_remove(struct ccat_device *const dev)

   246

{

   247

	struct ccat_function *func;

   248

	struct ccat_function *tmp;

   249

	list_for_each_entry_safe(func, tmp, &dev->functions, list) {

   250

		if (func->drv) {

   251

			func->drv->remove(func);

   252

			func->drv = NULL;

   253

		}

   254

		list_del(&func->list);

   255

		kfree(func);

   256

	}

   257

}

   258

   259

#ifdef CONFIG_PCI

   260

static int ccat_pci_probe(struct pci_dev *pdev, const struct pci_device_id *id)

   261

{

   262

	struct ccat_device *ccatdev;

   263

	u8 revision;

   264

	int status;

   265

   266

	ccatdev = devm_kzalloc(&pdev->dev, sizeof(*ccatdev), GFP_KERNEL);

   267

	if (!ccatdev) {

   268

		pr_err("%s() out of memory.\n", __FUNCTION__);

   269

		return -ENOMEM;

   270

	}

   271

	ccatdev->pdev = pdev;

   272

	pci_set_drvdata(pdev, ccatdev);

   273

   274

	status = pci_enable_device_mem(pdev);

   275

	if (status) {

   276

		pr_info("enable %s failed: %d\n", pdev->dev.kobj.name, status);

   277

		goto cleanup_pci_device;

   278

	}

   279

   280

	status = pci_read_config_byte(pdev, PCI_REVISION_ID, &revision);

   281

	if (status) {

   282

		pr_warn("read CCAT pci revision failed with %d\n", status);

   283

		goto cleanup_pci_device;

   284

	}

   285

   286

	if ((status = pci_request_regions(pdev, KBUILD_MODNAME))) {

   287

		pr_info("allocate mem_regions failed.\n");

   288

		goto cleanup_pci_device;

   289

	}

   290

   293

		pr_debug("32 bit DMA supported, pci rev: %u\n", revision);

   294

	} else {

   295

		pr_warn("No suitable DMA available, pci rev: %u\n", revision);

   296

	}

   297

   298

	if (!(ccatdev->bar_0 = pci_iomap(pdev, 0, 0))) {

   299

		pr_warn("initialization of bar0 failed.\n");

   300

		status = -EIO;

   301

		goto cleanup_pci_device;

   302

	}

   303

   304

	if (!(ccatdev->bar_2 = pci_iomap(pdev, 2, 0))) {

   305

		pr_warn("initialization of optional bar2 failed.\n");

   306

	}

   307

   308

	pci_set_master(pdev);

   309

	if (ccat_functions_init(ccatdev)) {

   310

		pr_warn("some functions couldn't be initialized\n");

   311

	}

   312

	return 0;

   313

cleanup_pci_device:

   314

	pci_disable_device(pdev);

   315

	return status;

   316

}

   317

   318

static void ccat_pci_remove(struct pci_dev *pdev)

   319

{

   320

	struct ccat_device *ccatdev = pci_get_drvdata(pdev);

   321

   322

	if (ccatdev) {

   323

		ccat_functions_remove(ccatdev);

   324

		if (ccatdev->bar_2)

   325

			pci_iounmap(pdev, ccatdev->bar_2);

   326

		pci_iounmap(pdev, ccatdev->bar_0);

   327

		pci_release_regions(pdev);

   328

		pci_disable_device(pdev);

   329

	}

   330

}

   331

   332

#define PCI_DEVICE_ID_BECKHOFF_CCAT 0x5000

   333

#define PCI_VENDOR_ID_BECKHOFF 0x15EC

   334

   335

static const struct pci_device_id pci_ids[] = {

   336

	{PCI_DEVICE(PCI_VENDOR_ID_BECKHOFF, PCI_DEVICE_ID_BECKHOFF_CCAT)},

   337

	{0,},

   338

};

   339

   340

MODULE_DEVICE_TABLE(pci, pci_ids);

   341

   342

static struct pci_driver ccat_pci_driver = {

   343

	.name = KBUILD_MODNAME,

   344

	.id_table = pci_ids,

   345

	.probe = ccat_pci_probe,

   346

	.remove = ccat_pci_remove,

   347

};

   348

   349

module_pci_driver(ccat_pci_driver);

   350

   351

#else /* #ifdef CONFIG_PCI */

   352

   353

static int ccat_eim_probe(struct platform_device *pdev)

   354

{

   355

	struct ccat_device *ccatdev;

   356

   357

	ccatdev = devm_kzalloc(&pdev->dev, sizeof(*ccatdev), GFP_KERNEL);

   358

	if (!ccatdev) {

   359

		pr_err("%s() out of memory.\n", __FUNCTION__);

   360

		return -ENOMEM;

   361

	}

   362

	ccatdev->pdev = pdev;

   363

	platform_set_drvdata(pdev, ccatdev);

   364

   365

	if (!request_mem_region(0xf0000000, 0x02000000, pdev->name)) {

   366

		pr_warn("request mem region failed.\n");

   367

		return -EIO;

   368

	}

   369

   370

	if (!(ccatdev->bar_0 = ioremap(0xf0000000, 0x02000000))) {

   371

		pr_warn("initialization of bar0 failed.\n");

   372

		return -EIO;

   373

	}

   374

   375

	ccatdev->bar_2 = NULL;

   376

   377

	if (ccat_functions_init(ccatdev)) {

   378

		pr_warn("some functions couldn't be initialized\n");

   379

	}

   380

	return 0;

   381

}

   382

   383

static int ccat_eim_remove(struct platform_device *pdev)

   384

{

   385

	struct ccat_device *ccatdev = platform_get_drvdata(pdev);

   386

   387

	if (ccatdev) {

   388

		ccat_functions_remove(ccatdev);

   389

		iounmap(ccatdev->bar_0);

   390

		release_mem_region(0xf0000000, 0x02000000);

   391

	}

   392

	return 0;

   393

}

   394

   395

static const struct of_device_id bhf_eim_ccat_ids[] = {

   396

	{.compatible = "bhf,emi-ccat",},

   397

	{}

   398

};

   399

   400

MODULE_DEVICE_TABLE(of, bhf_eim_ccat_ids);

   401

   402

static struct platform_driver ccat_eim_driver = {

   403

	.driver = {

   404

		   .name = KBUILD_MODNAME,

   405

		   .of_match_table = bhf_eim_ccat_ids,

   406

		   },

   407

	.probe = ccat_eim_probe,

   408

	.remove = ccat_eim_remove,

   409

};

   410

   411

module_platform_driver(ccat_eim_driver);

   412

#endif /* #ifdef CONFIG_PCI */