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

#include <linux/slab.h>

    39

    40

#include "soe_request.h"

    41

    42

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

    43

    44

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

    45

 */

    46

#define EC_SOE_REQUEST_RESPONSE_TIMEOUT 1000

    47

    48

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

    49

    50

void ec_soe_request_clear_data(ec_soe_request_t *);

    51

    52

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

    53

    54

/** SoE request constructor.

    55

 */

    56

void ec_soe_request_init(

    57

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

    58

        )

    59

{

    60

    req->drive_no = 0x00;

    61

    req->idn = 0x0000;

    62

    req->al_state = EC_AL_STATE_INIT;

    63

    req->data = NULL;

    64

    req->mem_size = 0;

    65

    req->data_size = 0;

    66

    req->dir = EC_DIR_INVALID;

    67

    req->state = EC_INT_REQUEST_INIT;

    68

    req->jiffies_sent = 0U;

    69

    req->error_code = 0x0000;

    70

}

    71

    72

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

    73

    74

/** SoE request destructor.

    75

 */

    76

void ec_soe_request_clear(

    77

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

    78

        )

    79

{

    80

    ec_soe_request_clear_data(req);

    81

}

    82

    83

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

    84

    85

/** Copy another SoE request.

    86

 */

    87

int ec_soe_request_copy(

    88

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

    89

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

    90

        )

    91

{

    92

    req->drive_no = other->drive_no;

    93

    req->idn = other->idn;

    94

    req->al_state = other->al_state;

    95

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

    96

}

    97

    98

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

    99

   100

/** Set drive number.

   101

 */

   102

void ec_soe_request_set_drive_no(

   103

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

   104

        uint8_t drive_no /** Drive Number. */

   105

        )

   106

{

   107

    req->drive_no = drive_no;

   108

}

   109

   110

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

   111

   112

/** Set IDN.

   113

 */

   114

void ec_soe_request_set_idn(

   115

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

   116

        uint16_t idn /** IDN. */

   117

        )

   118

{

   119

    req->idn = idn;

   120

}

   121

   122

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

   123

   124

/** Free allocated memory.

   125

 */

   126

void ec_soe_request_clear_data(

   127

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

   128

        )

   129

{

   130

    if (req->data) {

   131

        kfree(req->data);

   132

        req->data = NULL;

   133

    }

   134

   135

    req->mem_size = 0;

   136

    req->data_size = 0;

   137

}

   138

   139

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

   140

   141

/** Pre-allocates the data memory.

   142

 *

   143

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

   144

 *

   145

 * \return 0 on success, otherwise -ENOMEM.

   146

 */

   147

int ec_soe_request_alloc(

   148

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

   149

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

   150

        )

   151

{

   152

    if (size <= req->mem_size)

   153

        return 0;

   154

   155

    ec_soe_request_clear_data(req);

   156

   157

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

   158

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

   159

        return -ENOMEM;

   160

    }

   161

   162

    req->mem_size = size;

   163

    req->data_size = 0;

   164

    return 0;

   165

}

   166

   167

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

   168

   169

/** Copies SoE data from an external source.

   170

 *

   171

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

   172

 *

   173

 * \retval  0 Success.

   174

 * \retval <0 Error code.

   175

 */

   176

int ec_soe_request_copy_data(

   177

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

   178

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

   179

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

   180

        )

   181

{

   182

    int ret = ec_soe_request_alloc(req, size);

   183

    if (ret < 0)

   184

        return ret;

   185

   186

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

   187

    req->data_size = size;

   188

    return 0;

   189

}

   190

   191

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

   192

   193

/** Copies SoE data from an external source.

   194

 *

   195

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

   196

 *

   197

 * \retval  0 Success.

   198

 * \retval <0 Error code.

   199

 */

   200

int ec_soe_request_append_data(

   201

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

   202

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

   203

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

   204

        )

   205

{

   206

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

   207

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

   208

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

   209

        if (!new_data) {

   210

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

   211

                    new_size);

   212

            return -ENOMEM;

   213

        }

   214

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

   215

        kfree(req->data);

   216

        req->data = new_data;

   217

        req->mem_size = new_size;

   218

    }

   219

   220

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

   221

    req->data_size += size;

   222

    return 0;

   223

}

   224

   225

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

   226

   227

/** Request a read operation.

   228

 */

   229

void ec_soe_request_read(

   230

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

   231

       )

   232

{

   233

    req->dir = EC_DIR_INPUT;

   234

    req->state = EC_INT_REQUEST_QUEUED;

   235

    req->error_code = 0x0000;

   236

}

   237

   238

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

   239

   240

/** Request a write operation.

   241

 */

   242

void ec_soe_request_write(

   243

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

   244

        )

   245

{

   246

    req->dir = EC_DIR_OUTPUT;

   247

    req->state = EC_INT_REQUEST_QUEUED;

   248

    req->error_code = 0x0000;

   249

}

   250

   251

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