1

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

     2

 *

     3

 *  $Id$

     4

 *

     5

 *  Copyright (C) 2006-2008  Florian Pose, Ingenieurgemeinschaft IgH

     6

 *

     7

 *  This file is part of the IgH EtherCAT Master.

     8

 *

     9

 *  The IgH EtherCAT Master is free software; you can redistribute it and/or

    10

 *  modify it under the terms of the GNU General Public License version 2, as

    11

 *  published by the Free Software Foundation.

    12

 *

    13

 *  The IgH EtherCAT Master is distributed in the hope that it will be useful,

    14

 *  but WITHOUT ANY WARRANTY; without even the implied warranty of

    15

 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General

    16

 *  Public License for more details.

    17

 *

    18

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

    19

 *  with the IgH EtherCAT Master; if not, write to the Free Software

    20

 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

    21

 *

    22

 *  ---

    23

 *

    24

 *  The license mentioned above concerns the source code only. Using the

    25

 *  EtherCAT technology and brand is only permitted in compliance with the

    26

 *  industrial property and similar rights of Beckhoff Automation GmbH.

    27

 *

    28

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

    29

    30

/** \file

    31

 * Global definitions and macros.

    32

 */

    33

    34

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

    35

    36

#ifndef __EC_MASTER_GLOBALS_H__

    37

#define __EC_MASTER_GLOBALS_H__

    38

    39

#include "../globals.h"

    40

#include "../include/ecrt.h"

    41

    42

#ifdef __KERNEL__

    43

#ifdef EC_USE_MUTEX

    44

#include <linux/rtmutex.h>

    45

#endif  // EC_USE_MUTEX

    46

#endif // __KERNEL__

    47

    48

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

    49

 * EtherCAT master

    50

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

    51

    52

/** Datagram timeout in microseconds. */

    53

#define EC_IO_TIMEOUT 500

    54

    55

/** FSM injection timeout in microseconds. */

    56

#define EC_FSM_INJECTION_TIMEOUT 10000

    57

    58

/** Time to send a byte in nanoseconds.

    59

 *

    60

 * t_ns = 1 / (100 MBit/s / 8 bit/byte) = 80 ns/byte

    61

 */

    62

#define EC_BYTE_TRANSMISSION_TIME_NS 80

    63

    64

/** Number of state machine retries on datagram timeout. */

    65

#define EC_FSM_RETRIES 3

    66

    67

/** Seconds to wait before fetching SDO dictionary

    68

    after slave entered PREOP state. */

    69

#define EC_WAIT_SDO_DICT 3

    70

    71

/** Minimum size of a buffer used with ec_state_string(). */

    72

#define EC_STATE_STRING_SIZE 32

    73

    74

/** Maximum SII size in words, to avoid infinite reading. */

    75

#define EC_MAX_SII_SIZE 4096

    76

    77

/** Number of statistic rate intervals to maintain. */

    78

#define EC_RATE_COUNT 3

    79

    80

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

    81

 * EtherCAT protocol

    82

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

    83

    84

/** Size of an EtherCAT frame header. */

    85

#define EC_FRAME_HEADER_SIZE 2

    86

    87

/** Size of an EtherCAT datagram header. */

    88

#define EC_DATAGRAM_HEADER_SIZE 10

    89

    90

/** Size of an EtherCAT datagram footer. */

    91

#define EC_DATAGRAM_FOOTER_SIZE 2

    92

    93

/** Size of the EtherCAT address field. */

    94

#define EC_ADDR_LEN 4

    95

    96

/** Resulting maximum data size of a single datagram in a frame. */

    97

#define EC_MAX_DATA_SIZE (ETH_DATA_LEN - EC_FRAME_HEADER_SIZE \

    98

                          - EC_DATAGRAM_HEADER_SIZE - EC_DATAGRAM_FOOTER_SIZE)

    99

   100

/** Mailbox header size.  */

   101

#define EC_MBOX_HEADER_SIZE 6

   102

   103

/** Word offset of first SII category. */

   104

#define EC_FIRST_SII_CATEGORY_OFFSET 0x40

   105

   106

/** Size of a sync manager configuration page. */

   107

#define EC_SYNC_PAGE_SIZE 8

   108

   109

/** Maximum number of FMMUs per slave. */

   110

#define EC_MAX_FMMUS 16

   111

   112

/** Size of an FMMU configuration page. */

   113

#define EC_FMMU_PAGE_SIZE 16

   114

   115

/** Number of DC sync signals. */

   116

#define EC_SYNC_SIGNAL_COUNT 2

   117

   118

/** Size of the datagram description string.

   119

 *

   120

 * This is also used as the maximum lenth of EoE device names.

   121

 **/

   122

#define EC_DATAGRAM_NAME_SIZE 20

   123

   124

/** Slave state mask.

   125

 *

   126

 * Apply this mask to a slave state byte to get the slave state without

   127

 * the error flag.

   128

 */

   129

#define EC_SLAVE_STATE_MASK 0x0F

   130

   131

/** State of an EtherCAT slave.

   132

 */

   133

typedef enum {

   134

    EC_SLAVE_STATE_UNKNOWN = 0x00,

   135

    /**< unknown state */

   136

    EC_SLAVE_STATE_INIT = 0x01,

   137

    /**< INIT state (no mailbox communication, no IO) */

   138

    EC_SLAVE_STATE_PREOP = 0x02,

   139

    /**< PREOP state (mailbox communication, no IO) */

   140

    EC_SLAVE_STATE_BOOT = 0x03,

   141

    /**< Bootstrap state (mailbox communication, firmware update) */

   142

    EC_SLAVE_STATE_SAFEOP = 0x04,

   143

    /**< SAFEOP (mailbox communication and input update) */

   144

    EC_SLAVE_STATE_OP = 0x08,

   145

    /**< OP (mailbox communication and input/output update) */

   146

    EC_SLAVE_STATE_ACK_ERR = 0x10

   147

    /**< Acknowledge/Error bit (no actual state) */

   148

} ec_slave_state_t;

   149

   150

/** Supported mailbox protocols.

   151

 */

   152

enum {

   153

    EC_MBOX_AOE = 0x01, /**< ADS over EtherCAT */

   154

    EC_MBOX_EOE = 0x02, /**< Ethernet over EtherCAT */

   155

    EC_MBOX_COE = 0x04, /**< CANopen over EtherCAT */

   156

    EC_MBOX_FOE = 0x08, /**< File-Access over EtherCAT */

   157

    EC_MBOX_SOE = 0x10, /**< Servo-Profile over EtherCAT */

   158

    EC_MBOX_VOE = 0x20  /**< Vendor specific */

   159

};

   160

   161

/** Slave information interface CANopen over EtherCAT details flags.

   162

 */

   163

typedef struct {

   164

    uint8_t enable_sdo : 1; /**< Enable SDO access. */

   165

    uint8_t enable_sdo_info : 1; /**< SDO information service available. */

   166

    uint8_t enable_pdo_assign : 1; /**< PDO mapping configurable. */

   167

    uint8_t enable_pdo_configuration : 1; /**< PDO configuration possible. */

   168

    uint8_t enable_upload_at_startup : 1; /**< ?. */

   169

    uint8_t enable_sdo_complete_access : 1; /**< Complete access possible. */

   170

} ec_sii_coe_details_t;

   171

   172

/** Slave information interface general flags.

   173

 */

   174

typedef struct {

   175

    uint8_t enable_safeop : 1; /**< ?. */

   176

    uint8_t enable_not_lrw : 1; /**< Slave does not support LRW. */

   177

} ec_sii_general_flags_t;

   178

   179

/** EtherCAT slave distributed clocks range.

   180

 */

   181

typedef enum {

   182

    EC_DC_32, /**< 32 bit. */

   183

    EC_DC_64 /*< 64 bit for system time, system time offset and

   184

               port 0 receive time. */

   185

} ec_slave_dc_range_t;

   186

   187

/** EtherCAT slave sync signal configuration.

   188

 */

   189

typedef struct {

   190

    uint32_t cycle_time; /**< Cycle time [ns]. */

   191

    uint32_t shift_time; /**< Shift time [ns]. */

   192

} ec_sync_signal_t;

   193

   194

/** Access states for SDO entries.

   195

 *

   196

 * The access rights are managed per AL state.

   197

 */

   198

enum {

   199

    EC_SDO_ENTRY_ACCESS_PREOP, /**< Access rights in PREOP. */

   200

    EC_SDO_ENTRY_ACCESS_SAFEOP, /**< Access rights in SAFEOP. */

   201

    EC_SDO_ENTRY_ACCESS_OP, /**< Access rights in OP. */

   202

    EC_SDO_ENTRY_ACCESS_COUNT /**< Number of states. */

   203

};

   204

   205

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

   206

   207

/** Convenience macro for printing EtherCAT-specific information to syslog.

   208

 *

   209

 * This will print the message in \a fmt with a prefixed "EtherCAT: ".

   210

 *

   211

 * \param fmt format string (like in printf())

   212

 * \param args arguments (optional)

   213

 */

   214

#define EC_INFO(fmt, args...) \

   215

    printk(KERN_INFO "EtherCAT: " fmt, ##args)

   216

   217

/** Convenience macro for printing EtherCAT-specific errors to syslog.

   218

 *

   219

 * This will print the message in \a fmt with a prefixed "EtherCAT ERROR: ".

   220

 *

   221

 * \param fmt format string (like in printf())

   222

 * \param args arguments (optional)

   223

 */

   224

#define EC_ERR(fmt, args...) \

   225

    printk(KERN_ERR "EtherCAT ERROR: " fmt, ##args)

   226

   227

/** Convenience macro for printing EtherCAT-specific warnings to syslog.

   228

 *

   229

 * This will print the message in \a fmt with a prefixed "EtherCAT WARNING: ".

   230

 *

   231

 * \param fmt format string (like in printf())

   232

 * \param args arguments (optional)

   233

 */

   234

#define EC_WARN(fmt, args...) \

   235

    printk(KERN_WARNING "EtherCAT WARNING: " fmt, ##args)

   236

   237

/** Convenience macro for printing EtherCAT debug messages to syslog.

   238

 *

   239

 * This will print the message in \a fmt with a prefixed "EtherCAT DEBUG: ".

   240

 *

   241

 * \param fmt format string (like in printf())

   242

 * \param args arguments (optional)

   243

 */

   244

#define EC_DBG(fmt, args...) \

   245

    printk(KERN_DEBUG "EtherCAT DEBUG: " fmt, ##args)

   246

   247

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

   248

   249

/** Absolute value.

   250

 */

   251

#define EC_ABS(X) ((X) >= 0 ? (X) : -(X))

   252

   253

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

   254

   255

extern char *ec_master_version_str;

   256

   257

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

   258

   259

unsigned int ec_master_count(void);

   260

void ec_print_data(const uint8_t *, size_t);

   261

void ec_print_data_diff(const uint8_t *, const uint8_t *, size_t);

   262

size_t ec_state_string(uint8_t, char *, uint8_t);

   263

ssize_t ec_mac_print(const uint8_t *, char *);

   264

int ec_mac_is_zero(const uint8_t *);

   265

   266

ec_master_t *ecrt_request_master_err(unsigned int);

   267

   268

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

   269

   270

/** Code/Message pair.

   271

 *

   272

 * Some EtherCAT datagrams support reading a status code to display a certain

   273

 * message. This type allows to map a code to a message string.

   274

 */

   275

typedef struct {

   276

    uint32_t code; /**< Code. */

   277

    const char *message; /**< Message belonging to \a code. */

   278

} ec_code_msg_t;

   279

   280

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

   281

   282

/** Generic request state.

   283

 *

   284

 * \attention If ever changing this, please be sure to adjust the \a

   285

 * state_table in master/sdo_request.c.

   286

 */

   287

typedef enum {

   288

    EC_INT_REQUEST_INIT,

   289

    EC_INT_REQUEST_QUEUED,

   290

    EC_INT_REQUEST_BUSY,

   291

    EC_INT_REQUEST_SUCCESS,

   292

    EC_INT_REQUEST_FAILURE

   293

} ec_internal_request_state_t;

   294

   295

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

   296

   297

extern const ec_request_state_t ec_request_state_translation_table[];

   298

   299

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

   300

   301

/** Origin type.

   302

 */

   303

typedef enum {

   304

    EC_ORIG_INTERNAL, /**< Internal. */

   305

    EC_ORIG_EXTERNAL /**< External. */

   306

} ec_origin_t;

   307

   308

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

   309

   310

typedef struct ec_slave ec_slave_t; /**< \see ec_slave. */

   311

   312

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

   313

   314

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

   315

   316

#ifdef __KERNEL__

   317

   318

/** Mutual exclusion helpers.

   319

 *

   320

 */

   321

#ifdef EC_USE_MUTEX

   322

#define ec_mutex_t rt_mutex

   323

static inline void ec_mutex_init(struct ec_mutex_t *mutex)

   324

{

   325

    rt_mutex_init(mutex);

   326

}

   327

static inline void ec_mutex_lock(struct ec_mutex_t *mutex)

   328

{

   329

    rt_mutex_lock(mutex);

   330

}

   331

static inline int ec_mutex_trylock(struct ec_mutex_t *mutex)

   332

{

   333

    return rt_mutex_trylock(mutex);

   334

}

   335

static inline int ec_mutex_lock_interruptible(struct ec_mutex_t *mutex)

   336

{

   337

    return rt_mutex_lock_interruptible(mutex,0);

   338

}

   339

static inline void ec_mutex_unlock(struct ec_mutex_t *mutex)

   340

{

   341

    rt_mutex_unlock(mutex);

   342

}

   343

#else   // EC_USE_MUTEX

   344

#define ec_mutex_t semaphore

   345

static inline void ec_mutex_init(struct ec_mutex_t *sem)

   346

{

   347

    sema_init(sem, 1);

   348

}

   349

static inline void ec_mutex_lock(struct ec_mutex_t *sem)

   350

{

   351

    down(sem);

   352

}

   353

static inline int ec_mutex_trylock(struct ec_mutex_t *sem)

   354

{

   355

    down(sem);

   356

    return 1;

   357

}

   358

static inline int ec_mutex_lock_interruptible(struct ec_mutex_t *sem)

   359

{

   360

    return down_interruptible(sem);

   361

}

   362

static inline void ec_mutex_unlock(struct ec_mutex_t *sem)

   363

{

   364

    up(sem);

   365

}

   366

   367

#endif // EC_USE_MUTEX

   368

#endif // __KERNEL__

   369

   370

#endif