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

 * Canopen over EtherCAT SDO request functions.

    32

 */

    33

    34

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

    35

    36

#include <linux/module.h>

    37

#include <linux/jiffies.h>

    38

    39

#include "sdo_request.h"

    40

    41

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

    42

    43

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

    44

 */

    45

#define EC_SDO_REQUEST_RESPONSE_TIMEOUT 1000

    46

    47

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

    48

    49

void ec_sdo_request_clear_data(ec_sdo_request_t *);

    50

    51

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

    52

    53

/** SDO request constructor.

    54

 */

    55

void ec_sdo_request_init(

    56

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

    57

        )

    58

{

    59

    req->complete_access = 0;

    60

    req->data = NULL;

    61

    req->mem_size = 0;

    62

    req->data_size = 0;

    63

    req->dir = EC_DIR_INVALID;

    64

    req->issue_timeout = 0; // no timeout

    65

    req->response_timeout = EC_SDO_REQUEST_RESPONSE_TIMEOUT;

    66

    req->state = EC_INT_REQUEST_INIT;

    67

    req->abort_code = 0x00000000;

    68

}

    69

    70

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

    71

    72

/** SDO request destructor.

    73

 */

    74

void ec_sdo_request_clear(

    75

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

    76

        )

    77

{

    78

    ec_sdo_request_clear_data(req);

    79

}

    80

    81

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

    82

    83

/** Copy another SDO request.

    84

 *

    85

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

    86

 */

    87

int ec_sdo_request_copy(

    88

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

    89

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

    90

        )

    91

{

    92

    req->complete_access = other->complete_access;

    93

    req->index = other->index;

    94

    req->subindex = other->subindex;

    95

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

    96

}

    97

    98

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

    99

   100

/** SDO request destructor.

   101

 */

   102

void ec_sdo_request_clear_data(

   103

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

   104

        )

   105

{

   106

    if (req->data) {

   107

        kfree(req->data);

   108

        req->data = NULL;

   109

    }

   110

   111

    req->mem_size = 0;

   112

    req->data_size = 0;

   113

}

   114

   115

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

   116

   117

/** Set the SDO address.

   118

 */

   119

void ec_sdo_request_address(

   120

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

   121

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

   122

        uint8_t subindex /**< SDO subindex. */

   123

        )

   124

{

   125

    req->index = index;

   126

    req->subindex = subindex;

   127

}

   128

   129

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

   130

   131

/** Pre-allocates the data memory.

   132

 *

   133

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

   134

 *

   135

 * \return 0 on success, otherwise -ENOMEM.

   136

 */

   137

int ec_sdo_request_alloc(

   138

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

   139

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

   140

        )

   141

{

   142

    if (size <= req->mem_size)

   143

        return 0;

   144

   145

    ec_sdo_request_clear_data(req);

   146

   147

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

   148

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

   149

        return -ENOMEM;

   150

    }

   151

   152

    req->mem_size = size;

   153

    req->data_size = 0;

   154

    return 0;

   155

}

   156

   157

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

   158

   159

/** Copies SDO data from an external source.

   160

 *

   161

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

   162

 *

   163

 * \retval  0 Success.

   164

 * \retval <0 Error code.

   165

 */

   166

int ec_sdo_request_copy_data(

   167

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

   168

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

   169

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

   170

        )

   171

{

   172

    int ret = ec_sdo_request_alloc(req, size);

   173

    if (ret < 0)

   174

        return ret;

   175

   176

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

   177

    req->data_size = size;

   178

    return 0;

   179

}

   180

   181

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

   182

   183

/** Checks, if the timeout was exceeded.

   184

 *

   185

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

   186

 */

   187

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

   188

{

   189

    return req->issue_timeout

   190

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

   191

}

   192

   193

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

   194

 * Application interface.

   195

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

   196

   197

void ecrt_sdo_request_timeout(ec_sdo_request_t *req, uint32_t timeout)

   198

{

   199

    req->issue_timeout = timeout;

   200

}

   201

   202

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

   203

   204

uint8_t *ecrt_sdo_request_data(ec_sdo_request_t *req)

   205

{

   206

    return req->data;

   207

}

   208

   209

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

   210

   211

size_t ecrt_sdo_request_data_size(const ec_sdo_request_t *req)

   212

{

   213

    return req->data_size;

   214

}

   215

   216

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

   217

   218

ec_request_state_t ecrt_sdo_request_state(const ec_sdo_request_t *req)

   219

{

   220

   return ec_request_state_translation_table[req->state];

   221

}

   222

   223

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

   224

   225

void ecrt_sdo_request_read(ec_sdo_request_t *req)

   226

{

   227

    req->dir = EC_DIR_INPUT;

   228

    req->state = EC_INT_REQUEST_QUEUED;

   229

    req->abort_code = 0x00000000;

   230

    req->jiffies_start = jiffies;

   231

}

   232

   233

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

   234

   235

void ecrt_sdo_request_write(ec_sdo_request_t *req)

   236

{

   237

    req->dir = EC_DIR_OUTPUT;

   238

    req->state = EC_INT_REQUEST_QUEUED;

   239

    req->abort_code = 0x00000000;

   240

    req->jiffies_start = jiffies;

   241

}

   242

   243

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

   244

   245

/** \cond */

   246

   247

EXPORT_SYMBOL(ecrt_sdo_request_timeout);

   248

EXPORT_SYMBOL(ecrt_sdo_request_data);

   249

EXPORT_SYMBOL(ecrt_sdo_request_data_size);

   250

EXPORT_SYMBOL(ecrt_sdo_request_state);

   251

EXPORT_SYMBOL(ecrt_sdo_request_read);

   252

EXPORT_SYMBOL(ecrt_sdo_request_write);

   253

   254

/** \endcond */

   255

   256

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