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

/** SDO request constructor.

    51

 */

    52

void ec_sdo_request_init(

    53

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

    54

        )

    55

{

    56

    req->data = NULL;

    57

    req->mem_size = 0;

    58

    req->data_size = 0;

    59

    req->dir = EC_DIR_INVALID;

    60

    req->issue_timeout = 0; // no timeout

    61

    req->response_timeout = EC_SDO_REQUEST_RESPONSE_TIMEOUT;

    62

    req->state = EC_INT_REQUEST_INIT;

    63

    req->abort_code = 0x00000000;

    64

}

    65

    66

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

    67

    68

/** SDO request destructor.

    69

 */

    70

void ec_sdo_request_clear(

    71

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

    72

        )

    73

{

    74

    ec_sdo_request_clear_data(req);

    75

}

    76

    77

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

    78

    79

/** Copy another SDO request.

    80

 *

    81

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

    82

 */

    83

int ec_sdo_request_copy(

    84

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

    85

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

    86

        )

    87

{

    88

    req->index = other->index;

    89

    req->subindex = other->subindex;

    90

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

    91

}

    92

    93

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

    94

    95

/** SDO request destructor.

    96

 */

    97

void ec_sdo_request_clear_data(

    98

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

    99

        )

   100

{

   101

    if (req->data) {

   102

        kfree(req->data);

   103

        req->data = NULL;

   104

    }

   105

   106

    req->mem_size = 0;

   107

    req->data_size = 0;

   108

}

   109

   110

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

   111

   112

/** Set the SDO address.

   113

 */

   114

void ec_sdo_request_address(

   115

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

   116

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

   117

        uint8_t subindex /**< SDO subindex. */

   118

        )

   119

{

   120

    req->index = index;

   121

    req->subindex = subindex;

   122

}

   123

   124

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

   125

   126

/** Pre-allocates the data memory.

   127

 *

   128

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

   129

 *

   130

 * \return 0 on success, otherwise -ENOMEM.

   131

 */

   132

int ec_sdo_request_alloc(

   133

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

   134

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

   135

        )

   136

{

   137

    if (size <= req->mem_size)

   138

        return 0;

   139

   140

    ec_sdo_request_clear_data(req);

   141

   142

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

   143

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

   144

        return -ENOMEM;

   145

    }

   146

   147

    req->mem_size = size;

   148

    req->data_size = 0;

   149

    return 0;

   150

}

   151

   152

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

   153

   154

/** Copies SDO data from an external source.

   155

 *

   156

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

   157

 *

   158

 * \retval  0 Success.

   159

 * \retval <0 Error code.

   160

 */

   161

int ec_sdo_request_copy_data(

   162

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

   163

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

   164

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

   165

        )

   166

{

   167

    int ret = ec_sdo_request_alloc(req, size);

   168

    if (ret < 0)

   169

        return ret;

   170

   171

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

   172

    req->data_size = size;

   173

    return 0;

   174

}

   175

   176

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

   177

   178

/** Checks, if the timeout was exceeded.

   179

 *

   180

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

   181

 */

   182

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

   183

{

   184

    return req->issue_timeout

   185

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

   186

}

   187

   188

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

   189

 * Realtime interface.

   190

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

   191

   192

void ecrt_sdo_request_timeout(ec_sdo_request_t *req, uint32_t timeout)

   193

{

   194

    req->issue_timeout = timeout;

   195

}

   196

   197

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

   198

   199

uint8_t *ecrt_sdo_request_data(ec_sdo_request_t *req)

   200

{

   201

    return req->data;

   202

}

   203

   204

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

   205

   206

size_t ecrt_sdo_request_data_size(const ec_sdo_request_t *req)

   207

{

   208

    return req->data_size;

   209

}

   210

   211

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

   212

   213

ec_request_state_t ecrt_sdo_request_state(const ec_sdo_request_t *req)

   214

{

   215

   return ec_request_state_translation_table[req->state];

   216

}

   217

   218

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

   219

   220

void ecrt_sdo_request_read(ec_sdo_request_t *req)

   221

{

   222

    req->dir = EC_DIR_INPUT;

   223

    req->state = EC_INT_REQUEST_QUEUED;

   224

    req->abort_code = 0x00000000;

   225

    req->jiffies_start = jiffies;

   226

}

   227

   228

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

   229

   230

void ecrt_sdo_request_write(ec_sdo_request_t *req)

   231

{

   232

    req->dir = EC_DIR_OUTPUT;

   233

    req->state = EC_INT_REQUEST_QUEUED;

   234

    req->abort_code = 0x00000000;

   235

    req->jiffies_start = jiffies;

   236

}

   237

   238

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

   239

   240

/** \cond */

   241

   242

EXPORT_SYMBOL(ecrt_sdo_request_timeout);

   243

EXPORT_SYMBOL(ecrt_sdo_request_data);

   244

EXPORT_SYMBOL(ecrt_sdo_request_data_size);

   245

EXPORT_SYMBOL(ecrt_sdo_request_state);

   246

EXPORT_SYMBOL(ecrt_sdo_request_read);

   247

EXPORT_SYMBOL(ecrt_sdo_request_write);

   248

   249

/** \endcond */

   250

   251

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