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

/**

    31

   \file

    32

   Mailbox functionality.

    33

*/

    34

    35

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

    36

    37

#include <linux/slab.h>

    38

#include <linux/delay.h>

    39

    40

#include "mailbox.h"

    41

#include "datagram.h"

    42

#include "master.h"

    43

    44

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

    45

    46

/**

    47

   Prepares a mailbox-send datagram.

    48

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

    49

*/

    50

    51

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

    52

                                    ec_datagram_t *datagram, /**< datagram */

    53

                                    uint8_t type, /**< mailbox protocol */

    54

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

    55

                                    )

    56

{

    57

    size_t total_size;

    58

    int ret;

    59

    60

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

    61

        EC_SLAVE_ERR(slave, "Slave does not support mailbox"

    62

                " communication!\n");

    63

        return ERR_PTR(-EPROTONOSUPPORT);

    64

    }

    65

    66

    total_size = EC_MBOX_HEADER_SIZE + size;

    67

    68

    if (unlikely(total_size > slave->configured_rx_mailbox_size)) {

    69

        EC_SLAVE_ERR(slave, "Data size (%zu) does not fit in mailbox (%u)!\n",

    70

                total_size, slave->configured_rx_mailbox_size);

    71

        return ERR_PTR(-EOVERFLOW);

    72

    }

    73

    74

    ret = ec_datagram_fpwr(datagram, slave->station_address,

    75

            slave->configured_rx_mailbox_offset,

    76

            slave->configured_rx_mailbox_size);

    77

    if (ret)

    78

        return ERR_PTR(ret);

    79

    80

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

    81

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

    82

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

    83

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

    84

    85

    return datagram->data + EC_MBOX_HEADER_SIZE;

    86

}

    87

    88

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

    89

    90

/**

    91

   Prepares a datagram for checking the mailbox state.

    92

   \todo Determine sync manager used for receive mailbox

    93

   \return 0 in case of success, else < 0

    94

*/

    95

    96

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

    97

                                ec_datagram_t *datagram /**< datagram */

    98

                                )

    99

{

   100

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

   101

    if (ret)

   102

        return ret;

   103

   104

    ec_datagram_zero(datagram);

   105

    return 0;

   106

}

   107

   108

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

   109

   110

/**

   111

   Processes a mailbox state checking datagram.

   112

   \return 0 in case of success, else < 0

   113

*/

   114

   115

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

   116

{

   117

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

   118

}

   119

   120

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

   121

   122

/**

   123

   Prepares a datagram to fetch mailbox data.

   124

   \return 0 in case of success, else < 0

   125

*/

   126

   127

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

   128

                                ec_datagram_t *datagram /**< datagram */

   129

                                )

   130

{

   131

    int ret = ec_datagram_fprd(datagram, slave->station_address,

   132

            slave->configured_tx_mailbox_offset,

   133

            slave->configured_tx_mailbox_size);

   134

    if (ret)

   135

        return ret;

   136

   137

    ec_datagram_zero(datagram);

   138

    return 0;

   139

}

   140

   141

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

   142

   143

/**

   144

   Mailbox error codes.

   145

*/

   146

   147

const ec_code_msg_t mbox_error_messages[] = {

   148

    {0x00000001, "MBXERR_SYNTAX"},

   149

    {0x00000002, "MBXERR_UNSUPPORTEDPROTOCOL"},

   150

    {0x00000003, "MBXERR_INVAILDCHANNEL"},

   151

    {0x00000004, "MBXERR_SERVICENOTSUPPORTED"},

   152

    {0x00000005, "MBXERR_INVALIDHEADER"},

   153

    {0x00000006, "MBXERR_SIZETOOSHORT"},

   154

    {0x00000007, "MBXERR_NOMOREMEMORY"},

   155

    {0x00000008, "MBXERR_INVALIDSIZE"},

   156

    {}

   157

};

   158

   159

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

   160

   161

/** Processes received mailbox data.

   162

 *

   163

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

   164

 */

   165

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

   166

                             const ec_datagram_t *datagram, /**< datagram */

   167

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

   168

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

   169

                             )

   170

{

   171

    size_t data_size;

   172

   173

    data_size = EC_READ_U16(datagram->data);

   174

   175

    if (data_size + EC_MBOX_HEADER_SIZE > slave->configured_tx_mailbox_size) {

   176

        EC_SLAVE_ERR(slave, "Corrupt mailbox response received!\n");

   177

        ec_print_data(datagram->data, slave->configured_tx_mailbox_size);

   178

        return ERR_PTR(-EPROTO);

   179

    }

   180

   181

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

   182

    *size = data_size;

   183

   184

    if (*type == 0x00) {

   185

        const ec_code_msg_t *mbox_msg;

   186

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

   187

   188

        EC_SLAVE_ERR(slave, "Mailbox error response received - ");

   189

   190

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

   191

            if (mbox_msg->code != code)

   192

                continue;

   193

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

   194

                    mbox_msg->code, mbox_msg->message);

   195

            break;

   196

        }

   197

   198

        if (!mbox_msg->code)

   199

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

   200

   201

        if (slave->master->debug_level)

   202

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

   203

   204

        return ERR_PTR(-EPROTO);

   205

    }

   206

   207

    return datagram->data + EC_MBOX_HEADER_SIZE;

   208

}

   209

   210

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