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

 * Sercos-over-EtherCAT request functions.

    32

 */

    33

    34

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

    35

    36

#include <linux/module.h>

    37

#include <linux/jiffies.h>

    38

    39

#include "soe_request.h"

    40

    41

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

    42

    43

/** Default timeout in ms to wait for SoE responses.

    44

 */

    45

#define EC_SOE_REQUEST_RESPONSE_TIMEOUT 1000

    46

    47

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

    48

    49

void ec_soe_request_clear_data(ec_soe_request_t *);

    50

    51

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

    52

    53

/** SoE request constructor.

    54

 */

    55

void ec_soe_request_init(

    56

        ec_soe_request_t *req /**< SoE request. */

    57

        )

    58

{

    59

    req->al_state = EC_AL_STATE_INIT;

    60

    req->data = NULL;

    61

    req->mem_size = 0;

    62

    req->data_size = 0;

    63

    req->dir = EC_DIR_INVALID;

    64

    req->state = EC_INT_REQUEST_INIT;

    65

    req->jiffies_sent = 0U;

    66

    req->error_code = 0x0000;

    67

}

    68

    69

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

    70

    71

/** SoE request destructor.

    72

 */

    73

void ec_soe_request_clear(

    74

        ec_soe_request_t *req /**< SoE request. */

    75

        )

    76

{

    77

    ec_soe_request_clear_data(req);

    78

}

    79

    80

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

    81

    82

/** Copy another SoE request.

    83

 */

    84

int ec_soe_request_copy(

    85

        ec_soe_request_t *req, /**< SoE request. */

    86

        const ec_soe_request_t *other /**< Other SoE request to copy from. */

    87

        )

    88

{

    89

    req->idn = other->idn;

    90

    req->al_state = other->al_state;

    91

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

    92

}

    93

    94

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

    95

    96

/** Set IDN.

    97

 */

    98

void ec_soe_request_set_idn(

    99

        ec_soe_request_t *req, /**< SoE request. */

   100

        uint16_t idn /** IDN. */

   101

        )

   102

{

   103

    req->idn = idn;

   104

}

   105

   106

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

   107

   108

/** Free allocated memory.

   109

 */

   110

void ec_soe_request_clear_data(

   111

        ec_soe_request_t *req /**< SoE request. */

   112

        )

   113

{

   114

    if (req->data) {

   115

        kfree(req->data);

   116

        req->data = NULL;

   117

    }

   118

   119

    req->mem_size = 0;

   120

    req->data_size = 0;

   121

}

   122

   123

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

   124

   125

/** Pre-allocates the data memory.

   126

 *

   127

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

   128

 *

   129

 * \return 0 on success, otherwise -ENOMEM.

   130

 */

   131

int ec_soe_request_alloc(

   132

        ec_soe_request_t *req, /**< SoE request. */

   133

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

   134

        )

   135

{

   136

    if (size <= req->mem_size)

   137

        return 0;

   138

   139

    ec_soe_request_clear_data(req);

   140

   141

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

   142

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

   143

        return -ENOMEM;

   144

    }

   145

   146

    req->mem_size = size;

   147

    req->data_size = 0;

   148

    return 0;

   149

}

   150

   151

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

   152

   153

/** Copies SoE data from an external source.

   154

 *

   155

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

   156

 *

   157

 * \retval  0 Success.

   158

 * \retval <0 Error code.

   159

 */

   160

int ec_soe_request_copy_data(

   161

        ec_soe_request_t *req, /**< SoE request. */

   162

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

   163

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

   164

        )

   165

{

   166

    int ret = ec_soe_request_alloc(req, size);

   167

    if (ret < 0)

   168

        return ret;

   169

   170

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

   171

    req->data_size = size;

   172

    return 0;

   173

}

   174

   175

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

   176

   177

/** Copies SoE data from an external source.

   178

 *

   179

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

   180

 *

   181

 * \retval  0 Success.

   182

 * \retval <0 Error code.

   183

 */

   184

int ec_soe_request_append_data(

   185

        ec_soe_request_t *req, /**< SoE request. */

   186

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

   187

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

   188

        )

   189

{

   190

    if (req->data_size + size > req->mem_size) {

   191

        size_t new_size = req->mem_size ? req->mem_size * 2 : size;

   192

        uint8_t *new_data = (uint8_t *) kmalloc(new_size, GFP_KERNEL);

   193

        if (!new_data) {

   194

            EC_ERR("Failed to allocate %zu bytes of SoE memory.\n",

   195

                    new_size);

   196

            return -ENOMEM;

   197

        }

   198

        memcpy(new_data, req->data, req->data_size);

   199

        kfree(req->data);

   200

        req->data = new_data;

   201

        req->mem_size = new_size;

   202

    }

   203

   204

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

   205

    req->data_size += size;

   206

    return 0;

   207

}

   208

   209

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

   210

   211

/** Request a read operation.

   212

 */

   213

void ec_soe_request_read(

   214

        ec_soe_request_t *req /**< SoE request. */

   215

       )

   216

{

   217

    req->dir = EC_DIR_INPUT;

   218

    req->state = EC_INT_REQUEST_QUEUED;

   219

    req->error_code = 0x0000;

   220

}

   221

   222

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

   223

   224

/** Request a write operation.

   225

 */

   226

void ec_soe_request_write(

   227

        ec_soe_request_t *req /**< SoE request. */

   228

        )

   229

{

   230

    req->dir = EC_DIR_OUTPUT;

   231

    req->state = EC_INT_REQUEST_QUEUED;

   232

    req->error_code = 0x0000;

   233

}

   234

   235

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