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

#include "module.h"

    27

    28

MODULE_DESCRIPTION(DRV_DESCRIPTION);

    29

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

    30

MODULE_LICENSE("GPL");

    31

MODULE_VERSION(DRV_VERSION);

    32

    33

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

    34

/*

    35

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

    36

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

    37

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

    38

 * the same or smaller than the streaming DMA mask.

    39

 */

    40

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

    41

{

    42

	int rc = dma_set_mask(dev, mask);

    43

	if (rc == 0)

    44

		dma_set_coherent_mask(dev, mask);

    45

	return rc;

    46

}

    47

#endif

    48

    49

/**

    50

 * configure the drivers capabilities here

    51

 */

    52

static const struct ccat_driver *const drivers[] = {

    53

#ifdef CONFIG_PCI

    54

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

    55

#endif

    56

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

    57

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

    58

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

    59

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

    60

};

    61

    62

static int __init ccat_class_init(struct ccat_class *base)

    63

{

    64

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

    65

		if (alloc_chrdev_region

    66

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

    67

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

    68

				base->name);

    69

			return -1;

    70

		}

    71

    72

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

    73

		if (!base->class) {

    74

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

    75

				base->name);

    76

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

    77

			return -1;

    78

		}

    79

	}

    80

	return 0;

    81

}

    82

    83

static void ccat_class_exit(struct ccat_class *base)

    84

{

    85

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

    86

		class_destroy(base->class);

    87

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

    88

	}

    89

}

    90

    91

static void free_ccat_cdev(struct ccat_cdev *ccdev)

    92

{

    93

	ccat_class_exit(ccdev->class);

    94

	ccdev->dev = 0;

    95

}

    96

    97

static struct ccat_cdev *alloc_ccat_cdev(struct ccat_class *base)

    98

{

    99

	int i = 0;

   100

   101

	ccat_class_init(base);

   102

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

   103

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

   104

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

   105

			return &base->devices[i];

   106

		}

   107

	}

   108

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

   109

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

   110

	atomic_dec_return(&base->instances);

   111

	return NULL;

   112

}

   113

   114

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

   115

			  struct file_operations *fops)

   116

{

   117

	if (!device_create

   118

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

   119

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

   120

		return -1;

   121

	}

   122

   123

	cdev_init(cdev, fops);

   124

	cdev->owner = fops->owner;

   125

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

   126

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

   127

		device_destroy(class, dev);

   128

		return -1;

   129

	}

   130

   131

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

   132

	return 0;

   133

}

   134

   135

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

   136

{

   137

	struct ccat_cdev *ccdev =

   138

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

   139

	struct cdev_buffer *buf;

   140

   141

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

   142

		atomic_inc(&ccdev->in_use);

   143

		return -EBUSY;

   144

	}

   145

   146

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

   147

	if (!buf) {

   148

		atomic_inc(&ccdev->in_use);

   149

		return -ENOMEM;

   150

	}

   151

   152

	buf->ccdev = ccdev;

   153

	f->private_data = buf;

   154

	return 0;

   155

}

   156

   157

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

   158

		    size_t iosize)

   159

{

   160

	struct ccat_cdev *const ccdev = alloc_ccat_cdev(cdev_class);

   161

	if (!ccdev) {

   162

		return -ENOMEM;

   163

	}

   164

   165

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

   166

	ccdev->iosize = iosize;

   167

	atomic_set(&ccdev->in_use, 1);

   168

   169

	if (ccat_cdev_init

   170

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

   171

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

   172

		free_ccat_cdev(ccdev);

   173

		return -1;

   174

	}

   175

	ccdev->class = cdev_class;

   176

	func->private_data = ccdev;

   177

	return 0;

   178

}

   179

   180

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

   181

{

   182

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

   183

	struct ccat_cdev *const ccdev = buf->ccdev;

   184

   185

	kfree(f->private_data);

   186

	atomic_inc(&ccdev->in_use);

   187

	return 0;

   188

}

   189

   190

void ccat_cdev_remove(struct ccat_function *func)

   191

{

   192

	struct ccat_cdev *const ccdev = func->private_data;

   193

   194

	cdev_del(&ccdev->cdev);

   195

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

   196

	free_ccat_cdev(ccdev);

   197

}

   198

   199

static const struct ccat_driver *ccat_function_connect(struct ccat_function

   200

						       *const func)

   201

{

   202

	int i;

   203

   204

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

   205

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

   206

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

   207

		}

   208

	}

   209

	return NULL;

   210

}

   211

   212

/**

   213

 * Initialize all available CCAT functions.

   214

 *

   215

 * Return: count of failed functions

   216

 */

   217

static int ccat_functions_init(struct ccat_device *const ccatdev)

   218

{

   219

	static const size_t block_size = sizeof(struct ccat_info_block);

   220

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

   221

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

   222

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

   223

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

   224

   225

	INIT_LIST_HEAD(&ccatdev->functions);

   226

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

   227

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

   228

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

   229

			next->ccat = ccatdev;

   230

			next->drv = ccat_function_connect(next);

   231

			if (next->drv) {

   232

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

   233

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

   234

			}

   235

		}

   236

	}

   237

	kfree(next);

   238

	return list_empty(&ccatdev->functions);

   239

}

   240

   241

/**

   242

 * Destroy all previously initialized CCAT functions

   243

 */

   244

static void ccat_functions_remove(struct ccat_device *const dev)

   245

{

   246

	struct ccat_function *func;

   247

	struct ccat_function *tmp;

   248

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

   249

		if (func->drv) {

   250

			func->drv->remove(func);

   251

			func->drv = NULL;

   252

		}

   253

		list_del(&func->list);

   254

		kfree(func);

   255

	}

   256

}

   257

   258

#ifdef CONFIG_PCI

   259

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

   260

{

   261

	struct ccat_device *ccatdev;

   262

	u8 rev;

   263

	int status;

   264

   265

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

   266

	if (!ccatdev) {

   267

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

   268

		return -ENOMEM;

   269

	}

   270

	ccatdev->pdev = pdev;

   271

	pci_set_drvdata(pdev, ccatdev);

   272

   273

	status = pci_enable_device_mem(pdev);

   274

	if (status) {

   275

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

   276

		return status;

   277

	}

   278

   279

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

   280

	if (status) {

   281

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

   282

		goto disable_device;

   283

	}

   284

   285

	status = pci_request_regions(pdev, KBUILD_MODNAME);

   286

	if (status) {

   287

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

   288

		goto disable_device;

   289

	}

   290

   291

	status = dma_set_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(64));

   292

	if (status) {

   293

		status =

   294

		    dma_set_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(32));

   295

		if (status) {

   296

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

   297

			goto release_regions;

   298

		}

   299

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

   300

	} else {

   301

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

   302

	}

   303

   304

	ccatdev->bar_0 = pci_iomap(pdev, 0, 0);

   305

	if (!ccatdev->bar_0) {

   306

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

   307

		status = -EIO;

   308

		goto release_regions;

   309

	}

   310

   311

	ccatdev->bar_2 = pci_iomap(pdev, 2, 0);

   312

	if (!ccatdev->bar_2) {

   313

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

   314

	}

   315

   316

	pci_set_master(pdev);

   317

	if (ccat_functions_init(ccatdev)) {

   318

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

   319

	}

   320

	return 0;

   321

   322

release_regions:

   323

	pci_release_regions(pdev);

   324

disable_device:

   325

	pci_disable_device(pdev);

   326

	return status;

   327

}

   328

   329

static void ccat_pci_remove(struct pci_dev *pdev)

   330

{

   331

	struct ccat_device *ccatdev = pci_get_drvdata(pdev);

   332

   333

	if (ccatdev) {

   334

		ccat_functions_remove(ccatdev);

   335

		if (ccatdev->bar_2)

   336

			pci_iounmap(pdev, ccatdev->bar_2);

   337

		pci_iounmap(pdev, ccatdev->bar_0);

   338

		pci_release_regions(pdev);

   339

		pci_disable_device(pdev);

   340

	}

   341

}

   342

   343

#define PCI_DEVICE_ID_BECKHOFF_CCAT 0x5000

   344

#define PCI_VENDOR_ID_BECKHOFF 0x15EC

   345

   346

static const struct pci_device_id pci_ids[] = {

   347

	{PCI_DEVICE(PCI_VENDOR_ID_BECKHOFF, PCI_DEVICE_ID_BECKHOFF_CCAT)},

   348

	{0,},

   349

};

   350

   351

MODULE_DEVICE_TABLE(pci, pci_ids);

   352

   353

static struct pci_driver ccat_pci_driver = {

   354

	.name = KBUILD_MODNAME,

   355

	.id_table = pci_ids,

   356

	.probe = ccat_pci_probe,

   357

	.remove = ccat_pci_remove,

   358

};

   359

   360

module_pci_driver(ccat_pci_driver);

   361

   362

#else /* #ifdef CONFIG_PCI */

   363

   364

static int ccat_eim_probe(struct platform_device *pdev)

   365

{

   366

	struct ccat_device *ccatdev;

   367

   368

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

   369

	if (!ccatdev) {

   370

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

   371

		return -ENOMEM;

   372

	}

   373

	ccatdev->pdev = pdev;

   374

	platform_set_drvdata(pdev, ccatdev);

   375

   376

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

   377

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

   378

		return -EIO;

   379

	}

   380

   381

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

   382

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

   383

		return -EIO;

   384

	}

   385

   386

	ccatdev->bar_2 = NULL;

   387

   388

	if (ccat_functions_init(ccatdev)) {

   389

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

   390

	}

   391

	return 0;

   392

}

   393

   394

static int ccat_eim_remove(struct platform_device *pdev)

   395

{

   396

	struct ccat_device *ccatdev = platform_get_drvdata(pdev);

   397

   398

	if (ccatdev) {

   399

		ccat_functions_remove(ccatdev);

   400

		iounmap(ccatdev->bar_0);

   401

		release_mem_region(0xf0000000, 0x02000000);

   402

	}

   403

	return 0;

   404

}

   405

   406

static const struct of_device_id bhf_eim_ccat_ids[] = {

   407

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

   408

	{}

   409

};

   410

   411

MODULE_DEVICE_TABLE(of, bhf_eim_ccat_ids);

   412

   413

static struct platform_driver ccat_eim_driver = {

   414

	.driver = {

   415

		   .name = KBUILD_MODNAME,

   416

		   .of_match_table = bhf_eim_ccat_ids,

   417

		   },

   418

	.probe = ccat_eim_probe,

   419

	.remove = ccat_eim_remove,

   420

};

   421

   422

module_platform_driver(ccat_eim_driver);

   423

#endif /* #ifdef CONFIG_PCI */