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

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

    23

 *  the industrial property and similar rights of Beckhoff Automation GmbH.

    24

 *

    25

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

    26

    27

/** \file

    28

 * Canopen over EtherCAT SDO request functions.

    29

 */

    30

    31

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

    32

    33

#include <linux/module.h>

    34

#include <linux/jiffies.h>

    35

    36

#include "sdo_request.h"

    37

    38

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

    39

    40

/** Default timeout in ms to wait for SDO transfer responses.

    41

 */

    42

#define EC_SDO_REQUEST_RESPONSE_TIMEOUT 3000

    43

    44

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

    45

    46

void ec_sdo_request_clear_data(ec_sdo_request_t *);

    47

    48

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

    49

    50

/** State type translation table.

    51

 */

    52

static const ec_sdo_request_state_t state_translation_table[] = {

    53

    EC_SDO_REQUEST_UNUSED,  // EC_REQUEST_INIT,

    54

    EC_SDO_REQUEST_BUSY,    // EC_REQUEST_QUEUED,

    55

    EC_SDO_REQUEST_BUSY,    // EC_REQUEST_BUSY,

    56

    EC_SDO_REQUEST_SUCCESS, // EC_REQUEST_SUCCESS,

    57

    EC_SDO_REQUEST_ERROR    // EC_REQUEST_FAILURE

    58

};

    59

    60

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

    61

    62

/** SDO request constructor.

    63

 */

    64

void ec_sdo_request_init(

    65

        ec_sdo_request_t *req /**< SDO request. */

    66

        )

    67

{

    68

    req->data = NULL;

    69

    req->mem_size = 0;

    70

    req->data_size = 0;

    71

    req->dir = EC_DIR_INVALID;

    72

    req->issue_timeout = 0; // no timeout

    73

    req->response_timeout = EC_SDO_REQUEST_RESPONSE_TIMEOUT;

    74

    req->state = EC_REQUEST_INIT;

    75

    req->abort_code = 0x00000000;

    76

}

    77

    78

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

    79

    80

/** SDO request destructor.

    81

 */

    82

void ec_sdo_request_clear(

    83

        ec_sdo_request_t *req /**< SDO request. */

    84

        )

    85

{

    86

    ec_sdo_request_clear_data(req);

    87

}

    88

    89

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

    90

    91

/** Copy another SDO request.

    92

 *

    93

 * \attention Only the index subindex and data are copied.

    94

 */

    95

int ec_sdo_request_copy(

    96

        ec_sdo_request_t *req, /**< SDO request. */

    97

        const ec_sdo_request_t *other /**< Other SDO request to copy from. */

    98

        )

    99

{

   100

    req->index = other->index;

   101

    req->subindex = other->subindex;

   102

    return ec_sdo_request_copy_data(req, other->data, other->data_size);

   103

}

   104

   105

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

   106

   107

/** SDO request destructor.

   108

 */

   109

void ec_sdo_request_clear_data(

   110

        ec_sdo_request_t *req /**< SDO request. */

   111

        )

   112

{

   113

    if (req->data) {

   114

        kfree(req->data);

   115

        req->data = NULL;

   116

    }

   117

   118

    req->mem_size = 0;

   119

    req->data_size = 0;

   120

}

   121

   122

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

   123

   124

/** Set the SDO address.

   125

 */

   126

void ec_sdo_request_address(

   127

        ec_sdo_request_t *req, /**< SDO request. */

   128

        uint16_t index, /**< SDO index. */

   129

        uint8_t subindex /**< SDO subindex. */

   130

        )

   131

{

   132

    req->index = index;

   133

    req->subindex = subindex;

   134

}

   135

   136

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

   137

   138

/** Pre-allocates the data memory.

   139

 *

   140

 * If the \a mem_size is already bigger than \a size, nothing is done.

   141

 */

   142

int ec_sdo_request_alloc(

   143

        ec_sdo_request_t *req, /**< SDO request. */

   144

        size_t size /**< Data size to allocate. */

   145

        )

   146

{

   147

    if (size <= req->mem_size)

   148

        return 0;

   149

   150

    ec_sdo_request_clear_data(req);

   151

   152

    if (!(req->data = (uint8_t *) kmalloc(size, GFP_KERNEL))) {

   153

        EC_ERR("Failed to allocate %u bytes of SDO memory.\n", size);

   154

        return -1;

   155

    }

   156

   157

    req->mem_size = size;

   158

    req->data_size = 0;

   159

    return 0;

   160

}

   161

   162

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

   163

   164

/** Copies SDO data from an external source.

   165

 *

   166

 * If the \a mem_size is to small, new memory is allocated.

   167

 */

   168

int ec_sdo_request_copy_data(

   169

        ec_sdo_request_t *req, /**< SDO request. */

   170

        const uint8_t *source, /**< Source data. */

   171

        size_t size /**< Number of bytes in \a source. */

   172

        )

   173

{

   174

    if (ec_sdo_request_alloc(req, size))

   175

        return -1;

   176

   177

    memcpy(req->data, source, size);

   178

    req->data_size = size;

   179

    return 0;

   180

}

   181

   182

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

   183

   184

/** Checks, if the timeout was exceeded.

   185

 *

   186

 * \return non-zero if the timeout was exceeded, else zero.

   187

 */

   188

int ec_sdo_request_timed_out(const ec_sdo_request_t *req /**< SDO request. */)

   189

{

   190

    return req->issue_timeout

   191

        && jiffies - req->jiffies_start > HZ * req->issue_timeout / 1000;

   192

}

   193

   194

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

   195

 * Realtime interface.

   196

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

   197

   198

void ecrt_sdo_request_timeout(ec_sdo_request_t *req, uint32_t timeout)

   199

{

   200

    req->issue_timeout = timeout;

   201

}

   202

   203

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

   204

   205

uint8_t *ecrt_sdo_request_data(ec_sdo_request_t *req)

   206

{

   207

    return req->data;

   208

}

   209

   210

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

   211

   212

size_t ecrt_sdo_request_data_size(const ec_sdo_request_t *req)

   213

{

   214

    return req->data_size;

   215

}

   216

   217

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

   218

   219

ec_sdo_request_state_t ecrt_sdo_request_state(const ec_sdo_request_t *req)

   220

{

   221

   return state_translation_table[req->state];

   222

}

   223

   224

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

   225

   226

void ecrt_sdo_request_read(ec_sdo_request_t *req)

   227

{

   228

    req->dir = EC_DIR_INPUT;

   229

    req->state = EC_REQUEST_QUEUED;

   230

    req->abort_code = 0x00000000;

   231

    req->jiffies_start = jiffies;

   232

}

   233

   234

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

   235

   236

void ecrt_sdo_request_write(ec_sdo_request_t *req)

   237

{

   238

    req->dir = EC_DIR_OUTPUT;

   239

    req->state = EC_REQUEST_QUEUED;

   240

    req->abort_code = 0x00000000;

   241

    req->jiffies_start = jiffies;

   242

}

   243

   244

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

   245

   246

/** \cond */

   247

   248

EXPORT_SYMBOL(ecrt_sdo_request_timeout);

   249

EXPORT_SYMBOL(ecrt_sdo_request_data);

   250

EXPORT_SYMBOL(ecrt_sdo_request_data_size);

   251

EXPORT_SYMBOL(ecrt_sdo_request_state);

   252

EXPORT_SYMBOL(ecrt_sdo_request_read);

   253

EXPORT_SYMBOL(ecrt_sdo_request_write);

   254

   255

/** \endcond */

   256

   257

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