1

/******************************************************************************

     2

 *

     3

 *  ec_module.c

     4

 *

     5

 *  EtherCAT-Master-Treiber

     6

 *

     7

 *  Autoren: Wilhelm Hagemeister, Florian Pose

     8

 *

     9

 *  $Id$

    10

 *

    11

 *  (C) Copyright IgH 2005

    12

 *  Ingenieurgemeinschaft IgH

    13

 *  Heinz-Bäcker Str. 34

    14

 *  D-45356 Essen

    15

 *  Tel.: +49 201/61 99 31

    16

 *  Fax.: +49 201/61 98 36

    17

 *  E-mail: sp@igh-essen.com

    18

 *

    19

 ******************************************************************************/

    20

    21

#include <linux/module.h>

    22

#include <linux/kernel.h>

    23

#include <linux/init.h>

    24

    25

#include "ec_module.h"

    26

    27

/******************************************************************************/

    28

    29

#define LITERAL(X) #X

    30

#define STRINGIFY(X) LITERAL(X)

    31

    32

#define COMPILE_INFO "Revision " STRINGIFY(EC_REV) \

    33

                     ", compiled by " STRINGIFY(EC_USER) \

    34

                     " at " STRINGIFY(EC_DATE)

    35

    36

/******************************************************************************/

    37

    38

int ecat_master_count = 1;

    39

EtherCAT_master_t *ecat_masters = NULL;

    40

int *ecat_masters_reserved = NULL;

    41

    42

/******************************************************************************/

    43

    44

MODULE_AUTHOR ("Wilhelm Hagemeister <hm@igh-essen.com>, Florian Pose <fp@igh-essen.com>");

    45

MODULE_DESCRIPTION ("EtherCAT master driver module");

    46

MODULE_LICENSE("GPL");

    47

MODULE_VERSION(COMPILE_INFO);

    48

    49

module_param(ecat_master_count, int, 1);

    50

MODULE_PARM_DESC(ecat_master_count, "Number of EtherCAT master to initialize.");

    51

    52

module_init(ecat_init_module);

    53

module_exit(ecat_cleanup_module);

    54

    55

EXPORT_SYMBOL(EtherCAT_register_device);

    56

EXPORT_SYMBOL(EtherCAT_unregister_device);

    57

EXPORT_SYMBOL(EtherCAT_request);

    58

EXPORT_SYMBOL(EtherCAT_release);

    59

    60

/******************************************************************************/

    61

    62

/**

    63

   Init-Funktion des EtherCAT-Master-Treibermodules

    64

    65

   Initialisiert soviele Master, wie im Parameter ecat_master_count

    66

   angegeben wurde (Default ist 1).

    67

    68

   @returns 0, wenn alles o.k., -1 bei ungueltiger Anzahl Master

    69

            oder zu wenig Speicher.

    70

*/

    71

    72

int __init ecat_init_module(void)

    73

{

    74

  unsigned int i;

    75

    76

  printk(KERN_ERR "EtherCAT: Master driver, %s\n", COMPILE_INFO);

    77

    78

  if (ecat_master_count < 1)

    79

  {

    80

    printk(KERN_ERR "EtherCAT: Error - Illegal ecat_master_count: %i\n",

    81

           ecat_master_count);

    82

    return -1;

    83

  }

    84

    85

  printk(KERN_ERR "EtherCAT: Initializing %i EtherCAT master(s)...\n",

    86

         ecat_master_count);

    87

    88

  if ((ecat_masters = (EtherCAT_master_t *) kmalloc(sizeof(EtherCAT_master_t)

    89

                                                    * ecat_master_count,

    90

                                                    GFP_KERNEL)) == NULL)

    91

  {

    92

    printk(KERN_ERR "EtherCAT: Could not allocate memory for EtherCAT master(s)!\n");

    93

    return -1;

    94

  }

    95

    96

  if ((ecat_masters_reserved = (int *) kmalloc(sizeof(int) * ecat_master_count,

    97

                                               GFP_KERNEL)) == NULL)

    98

  {

    99

    printk(KERN_ERR "EtherCAT: Could not allocate memory for reservation flags!\n");

   100

    kfree(ecat_masters);

   101

    return -1;

   102

  }

   103

   104

  for (i = 0; i < ecat_master_count; i++)

   105

  {

   106

    EtherCAT_master_init(&ecat_masters[i]);

   107

    ecat_masters_reserved[i] = 0;

   108

  }

   109

   110

  printk(KERN_ERR "EtherCAT: Master driver initialized.\n");

   111

   112

  return 0;

   113

}

   114

   115

/******************************************************************************/

   116

   117

/**

   118

   Cleanup-Funktion des EtherCAT-Master-Treibermoduls

   119

   120

   Entfernt alle Master-Instanzen.

   121

*/

   122

   123

void __exit ecat_cleanup_module(void)

   124

{

   125

  unsigned int i;

   126

   127

  printk(KERN_ERR "EtherCAT: Cleaning up master driver...\n");

   128

   129

  if (ecat_masters)

   130

  {

   131

    for (i = 0; i < ecat_master_count; i++)

   132

    {

   133

      if (ecat_masters_reserved[i]) {

   134

        printk(KERN_WARNING "EtherCAT: Warning - Master %i is still in use!\n", i);

   135

      }

   136

   137

      EtherCAT_master_clear(&ecat_masters[i]);

   138

    }

   139

   140

    kfree(ecat_masters);

   141

  }

   142

   143

  printk(KERN_ERR "EtherCAT: Master driver cleaned up.\n");

   144

}

   145

   146

/***************************************************************/

   147

   148

/**

   149

   Setzt das EtherCAT-Geraet, auf dem der Master arbeitet.

   150

   151

   Registriert das Geraet beim Master, der es daraufhin oeffnet.

   152

   153

   @param master Der EtherCAT-Master

   154

   @param device Das EtherCAT-Geraet

   155

   @return 0, wenn alles o.k.,

   156

           < 0, wenn bereits ein Geraet registriert

   157

           oder das Geraet nicht geoeffnet werden konnte.

   158

*/

   159

   160

int EtherCAT_register_device(int index, EtherCAT_device_t *device)

   161

{

   162

  if (index < 0 || index >= ecat_master_count)

   163

  {

   164

    printk(KERN_ERR "EtherCAT: Master %i does not exist!\n", index);

   165

    return -1;

   166

  }

   167

   168

  return EtherCAT_master_open(&ecat_masters[index], device);

   169

}

   170

   171

/***************************************************************/

   172

   173

/**

   174

   Loescht das EtherCAT-Geraet, auf dem der Master arbeitet.

   175

   176

   @param master Der EtherCAT-Master

   177

   @param device Das EtherCAT-Geraet

   178

*/

   179

   180

void EtherCAT_unregister_device(int index, EtherCAT_device_t *device)

   181

{

   182

  if (index < 0 || index >= ecat_master_count)

   183

  {

   184

    printk(KERN_WARNING "EtherCAT: Master %i does not exist!\n", index);

   185

    return;

   186

  }

   187

   188

  EtherCAT_master_close(&ecat_masters[index], device);

   189

}

   190

   191

/******************************************************************************/

   192

   193

/**

   194

   Reserviert einen bestimmten EtherCAT-Master und das zugehörige Gerät.

   195

   196

   Gibt einen Zeiger auf den reservierten EtherCAT-Master zurueck.

   197

   198

   @param index Index des gewuenschten Masters

   199

   @returns Zeiger auf EtherCAT-Master oder NULL, wenn Parameter ungueltig.

   200

*/

   201

   202

EtherCAT_master_t *EtherCAT_request(int index)

   203

{

   204

  if (index < 0 || index >= ecat_master_count) {

   205

    printk(KERN_ERR "EtherCAT: Master %i does not exist!\n", index);

   206

    return NULL;

   207

  }

   208

   209

  if (ecat_masters_reserved[index]) {

   210

    printk(KERN_ERR "EtherCAT: Master %i already in use!\n", index);

   211

    return NULL;

   212

  }

   213

   214

  if (!ecat_masters[index].dev) {

   215

    printk(KERN_ERR "EtherCAT: Master %i has no device assigned yet!\n", index);

   216

    return NULL;

   217

  }

   218

   219

  if (!ecat_masters[index].dev->module) {

   220

    printk(KERN_ERR "EtherCAT: Master %i device module is not set!\n", index);

   221

    return NULL;

   222

  }

   223

   224

  if (!try_module_get(ecat_masters[index].dev->module)) {

   225

    printk(KERN_ERR "EtherCAT: Could not reserve device module!\n");

   226

    return NULL;

   227

  }

   228

   229

  ecat_masters_reserved[index] = 1;

   230

   231

  printk(KERN_INFO "EtherCAT: Reserved master %i.\n", index);

   232

   233

  return &ecat_masters[index];

   234

}

   235

   236

/******************************************************************************/

   237

   238

/**

   239

   Gibt einen zuvor reservierten EtherCAT-Master wieder frei.

   240

   241

   @param master Zeiger auf den freizugebenden EtherCAT-Master.

   242

*/

   243

   244

void EtherCAT_release(EtherCAT_master_t *master)

   245

{

   246

  unsigned int i;

   247

   248

  for (i = 0; i < ecat_master_count; i++)

   249

  {

   250

    if (&ecat_masters[i] == master)

   251

    {

   252

      if (!ecat_masters[i].dev) {

   253

        printk(KERN_WARNING "EtherCAT: Could not release device"

   254

               "module because of no device!\n");

   255

        return;

   256

      }

   257

   258

      module_put(ecat_masters[i].dev->module);

   259

      ecat_masters_reserved[i] = 0;

   260

   261

      printk(KERN_INFO "EtherCAT: Released master %i.\n", i);

   262

   263

      return;

   264

    }

   265

  }

   266

   267

  printk(KERN_WARNING "EtherCAT: Master %X was never reserved!\n",

   268

         (unsigned int) master);

   269

}

   270

   271

/******************************************************************************/