1

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

     2

 *

     3

 *  $Id$

     4

 *

     5

 *  Copyright (C) 2006  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

    10

 *  and/or modify it under the terms of the GNU General Public License

    11

 *  as published by the Free Software Foundation; either version 2 of the

    12

 *  License, or (at your option) any later version.

    13

 *

    14

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

    15

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

    16

 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    17

 *  GNU General Public License for more details.

    18

 *

    19

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

    20

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

    21

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

    22

 *

    23

 *  The right to use EtherCAT Technology is granted and comes free of

    24

 *  charge under condition of compatibility of product made by

    25

 *  Licensee. People intending to distribute/sell products based on the

    26

 *  code, have to sign an agreement to guarantee that products using

    27

 *  software based on IgH EtherCAT master stay compatible with the actual

    28

 *  EtherCAT specification (which are released themselves as an open

    29

 *  standard) as the (only) precondition to have the right to use EtherCAT

    30

 *  Technology, IP and trade marks.

    31

 *

    32

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

    33

    34

/** \file

    35

 * Canopen-over-EtherCAT Sdo request functions.

    36

 */

    37

    38

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

    39

    40

#include <linux/module.h>

    41

#include <linux/jiffies.h>

    42

    43

#include "sdo_request.h"

    44

    45

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

    46

    47

void ec_sdo_request_clear_data(ec_sdo_request_t *);

    48

    49

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

    50

    51

/** State type translation table.

    52

 */

    53

static const ec_sdo_request_state_t state_translation_table[] = {

    54

    EC_SDO_REQUEST_UNUSED,  // EC_REQUEST_INIT,

    55

    EC_SDO_REQUEST_BUSY,    // EC_REQUEST_QUEUED,

    56

    EC_SDO_REQUEST_BUSY,    // EC_REQUEST_BUSY,

    57

    EC_SDO_REQUEST_SUCCESS, // EC_REQUEST_SUCCESS,

    58

    EC_SDO_REQUEST_ERROR    // EC_REQUEST_FAILURE

    59

};

    60

    61

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

    62

    63

/** Sdo request constructor.

    64

 */

    65

void ec_sdo_request_init(

    66

        ec_sdo_request_t *req /**< Sdo request. */

    67

        )

    68

{

    69

    req->data = NULL;

    70

    req->mem_size = 0;

    71

    req->data_size = 0;

    72

    req->dir = EC_DIR_OUTPUT;

    73

    req->issue_timeout = 0; // no timeout

    74

    req->response_timeout = 0; // immediate response required

    75

    req->state = EC_REQUEST_INIT;

    76

    req->abort_code = 0x00000000;

    77

}

    78

    79

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

    80

    81

/** Sdo request destructor.

    82

 */

    83

void ec_sdo_request_clear(

    84

        ec_sdo_request_t *req /**< Sdo request. */

    85

        )

    86

{

    87

    ec_sdo_request_clear_data(req);

    88

}

    89

    90

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

    91

    92

/** Sdo request destructor.

    93

 */

    94

void ec_sdo_request_clear_data(

    95

        ec_sdo_request_t *req /**< Sdo request. */

    96

        )

    97

{

    98

    if (req->data) {

    99

        kfree(req->data);

   100

        req->data = NULL;

   101

    }

   102

   103

    req->mem_size = 0;

   104

    req->data_size = 0;

   105

}

   106

   107

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

   108

   109

/** Set the Sdo address.

   110

 */

   111

void ec_sdo_request_address(

   112

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

   113

        uint16_t index, /**< Sdo index. */

   114

        uint8_t subindex /**< Sdo subindex. */

   115

        )

   116

{

   117

    req->index = index;

   118

    req->subindex = subindex;

   119

}

   120

   121

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

   122

   123

/** Pre-allocates the data memory.

   124

 *

   125

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

   126

 */

   127

int ec_sdo_request_alloc(

   128

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

   129

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

   130

        )

   131

{

   132

    if (size <= req->mem_size)

   133

        return 0;

   134

   135

    ec_sdo_request_clear_data(req);

   136

   137

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

   138

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

   139

        return -1;

   140

    }

   141

   142

    req->mem_size = size;

   143

    req->data_size = 0;

   144

    return 0;

   145

}

   146

   147

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

   148

   149

/** Copies Sdo data from an external source.

   150

 *

   151

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

   152

 */

   153

int ec_sdo_request_copy_data(

   154

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

   155

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

   156

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

   157

        )

   158

{

   159

    if (ec_sdo_request_alloc(req, size))

   160

        return -1;

   161

   162

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

   163

    req->data_size = size;

   164

    return 0;

   165

}

   166

   167

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

   168

   169

/** Checks, if the timeout was exceeded.

   170

 *

   171

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

   172

 */

   173

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

   174

{

   175

    return req->issue_timeout

   176

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

   177

}

   178

   179

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

   180

 * Realtime interface.

   181

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

   182

   183

void ecrt_sdo_request_timeout(ec_sdo_request_t *req, uint32_t timeout)

   184

{

   185

    req->issue_timeout = timeout;

   186

}

   187

   188

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

   189

   190

uint8_t *ecrt_sdo_request_data(ec_sdo_request_t *req)

   191

{

   192

    return req->data;

   193

}

   194

   195

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

   196

   197

size_t ecrt_sdo_request_data_size(const ec_sdo_request_t *req)

   198

{

   199

    return req->data_size;

   200

}

   201

   202

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

   203

   204

ec_sdo_request_state_t ecrt_sdo_request_state(const ec_sdo_request_t *req)

   205

{

   206

   return state_translation_table[req->state];

   207

}

   208

   209

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

   210

   211

void ecrt_sdo_request_read(ec_sdo_request_t *req)

   212

{

   213

    req->dir = EC_DIR_INPUT;

   214

    req->state = EC_REQUEST_QUEUED;

   215

    req->abort_code = 0x00000000;

   216

    req->jiffies_start = jiffies;

   217

}

   218

   219

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

   220

   221

void ecrt_sdo_request_write(ec_sdo_request_t *req)

   222

{

   223

    req->dir = EC_DIR_OUTPUT;

   224

    req->state = EC_REQUEST_QUEUED;

   225

    req->abort_code = 0x00000000;

   226

    req->jiffies_start = jiffies;

   227

}

   228

   229

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

   230

   231

/** \cond */

   232

   233

EXPORT_SYMBOL(ecrt_sdo_request_timeout);

   234

EXPORT_SYMBOL(ecrt_sdo_request_data);

   235

EXPORT_SYMBOL(ecrt_sdo_request_data_size);

   236

EXPORT_SYMBOL(ecrt_sdo_request_state);

   237

EXPORT_SYMBOL(ecrt_sdo_request_read);

   238

EXPORT_SYMBOL(ecrt_sdo_request_write);

   239

   240

/** \endcond */

   241

   242

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