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

/**

    28

   \file

    29

   Mailbox functionality.

    30

*/

    31

    32

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

    33

    34

#include <linux/slab.h>

    35

#include <linux/delay.h>

    36

    37

#include "mailbox.h"

    38

#include "datagram.h"

    39

#include "master.h"

    40

    41

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

    42

    43

/**

    44

   Prepares a mailbox-send datagram.

    45

   \return Pointer to mailbox datagram data, or ERR_PTR() code.

    46

*/

    47

    48

uint8_t *ec_slave_mbox_prepare_send(const ec_slave_t *slave, /**< slave */

    49

                                    ec_datagram_t *datagram, /**< datagram */

    50

                                    uint8_t type, /**< mailbox protocol */

    51

                                    size_t size /**< size of the data */

    52

                                    )

    53

{

    54

    size_t total_size;

    55

    int ret;

    57

    58

    if (unlikely(!slave->sii.mailbox_protocols)) {

    59

        EC_ERR("Slave %u does not support mailbox communication!\n",

    60

               slave->ring_position);

    61

        return ERR_PTR(-EPROTONOSUPPORT);

    62

    }

    63

    64

    total_size = EC_MBOX_HEADER_SIZE + size;

    75

        EC_ERR("Data size does not fit in mailbox!\n");

    76

        return ERR_PTR(-EOVERFLOW);

    77

    }

    78

    79

    ret = ec_datagram_fpwr(datagram, slave->station_address,

    81

    if (ret)

    82

        return ERR_PTR(ret);

    83

    84

    EC_WRITE_U16(datagram->data,     size); // mailbox service data length

    85

    EC_WRITE_U16(datagram->data + 2, slave->station_address); // station addr.

    86

    EC_WRITE_U8 (datagram->data + 4, 0x00); // channel & priority

    87

    EC_WRITE_U8 (datagram->data + 5, type); // underlying protocol type

    88

    89

    return datagram->data + EC_MBOX_HEADER_SIZE;

    90

}

    91

    92

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

    93

    94

/**

    95

   Prepares a datagram for checking the mailbox state.

    96

   \todo Determine sync manager used for receive mailbox

    97

   \return 0 in case of success, else < 0

    98

*/

    99

   100

int ec_slave_mbox_prepare_check(const ec_slave_t *slave, /**< slave */

   101

                                ec_datagram_t *datagram /**< datagram */

   102

                                )

   103

{

   104

    int ret = ec_datagram_fprd(datagram, slave->station_address, 0x808, 8);

   105

    if (ret)

   106

        return ret;

   107

   108

    ec_datagram_zero(datagram);

   109

    return 0;

   110

}

   111

   112

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

   113

   114

/**

   115

   Processes a mailbox state checking datagram.

   116

   \return 0 in case of success, else < 0

   117

*/

   118

   119

int ec_slave_mbox_check(const ec_datagram_t *datagram /**< datagram */)

   120

{

   121

    return EC_READ_U8(datagram->data + 5) & 8 ? 1 : 0;

   122

}

   123

   124

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

   125

   126

/**

   127

   Prepares a datagram to fetch mailbox data.

   128

   \return 0 in case of success, else < 0

   129

*/

   130

   131

int ec_slave_mbox_prepare_fetch(const ec_slave_t *slave, /**< slave */

   132

                                ec_datagram_t *datagram /**< datagram */

   133

                                )

   134

{

   148

    if (ret)

   149

        return ret;

   150

   151

    ec_datagram_zero(datagram);

   152

    return 0;

   153

}

   154

   155

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

   156

   157

/**

   158

   Mailbox error codes.

   159

*/

   160

   161

const ec_code_msg_t mbox_error_messages[] = {

   162

    {0x00000001, "MBXERR_SYNTAX"},

   163

    {0x00000002, "MBXERR_UNSUPPORTEDPROTOCOL"},

   164

    {0x00000003, "MBXERR_INVAILDCHANNEL"},

   165

    {0x00000004, "MBXERR_SERVICENOTSUPPORTED"},

   166

    {0x00000005, "MBXERR_INVALIDHEADER"},

   167

    {0x00000006, "MBXERR_SIZETOOSHORT"},

   168

    {0x00000007, "MBXERR_NOMOREMEMORY"},

   169

    {0x00000008, "MBXERR_INVALIDSIZE"},

   170

    {}

   171

};

   172

   173

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

   174

   175

/** Processes received mailbox data.

   176

 *

   177

 * \return Pointer to the received data, or ERR_PTR() code.

   178

 */

   179

uint8_t *ec_slave_mbox_fetch(const ec_slave_t *slave, /**< slave */

   180

                             ec_datagram_t *datagram, /**< datagram */

   181

                             uint8_t *type, /**< expected mailbox protocol */

   182

                             size_t *size /**< size of the received data */

   183

                             )

   184

{

   185

    size_t data_size;

   195

   196

    data_size = EC_READ_U16(datagram->data);

   197

   199

        EC_ERR("Corrupt mailbox response received from slave %u!\n",

   202

        return ERR_PTR(-EPROTO);

   203

    }

   204

   205

    *type = EC_READ_U8(datagram->data + 5) & 0x0F;

   206

    *size = data_size;

   207

   208

    if (*type == 0x00) {

   209

        const ec_code_msg_t *mbox_msg;

   210

        uint16_t code = EC_READ_U16(datagram->data + 8);

   211

   212

        EC_ERR("Mailbox error response received from slave %u - ",

   213

                slave->ring_position);

   214

   215

        for (mbox_msg = mbox_error_messages; mbox_msg->code; mbox_msg++) {

   218

            printk("Code 0x%04X: \"%s\".\n",

   220

            break;

   221

        }

   222

   223

        if (!mbox_msg->code)

   224

            printk("Unknown error reply code 0x%04X.\n", code);

   225

   226

        if (slave->master->debug_level)

   227

            ec_print_data(datagram->data + EC_MBOX_HEADER_SIZE, data_size);

   228

   229

        return ERR_PTR(-EPROTO);

   230

    }

   231

   232

    return datagram->data + EC_MBOX_HEADER_SIZE;

   233

}

   234

   235

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