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 "slave.h"

    41

#include "mailbox.h"

    42

#include "datagram.h"

    43

#include "master.h"

    44

    45

    46

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

    47

    48

/**

    49

   Mailbox constructor.

    50

*/

    51

    52

void ec_mbox_init(ec_mailbox_t* mbox, /** mailbox */

    53

                        ec_datagram_t* datagram  /**< Datagram used for the mailbox content. */

    54

                        )

    55

{

    56

    mbox->datagram = datagram;

    57

#ifdef EC_REDUCE_MBOXFRAMESIZE

    58

    ec_datagram_init(&mbox->end_datagram);

    59

#endif

    60

}

    61

    62

    63

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

    64

    65

/**

    66

   Clears mailbox datagrams.

    67

*/

    68

    69

void ec_mbox_clear(ec_mailbox_t* mbox /** mailbox */

    70

                         )

    71

{

    72

#ifdef EC_REDUCE_MBOXFRAMESIZE

    73

    ec_datagram_clear(&mbox->end_datagram);

    74

#endif

    75

}

    76

    77

    78

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

    79

    80

/**

    81

   Queues the slave datagrams.

    82

*/

    83

    84

void  ec_slave_mbox_queue_datagrams(const ec_slave_t* slave, /** slave */

    85

                                    ec_mailbox_t* mbox /** mailbox */

    86

                                    )

    87

{

    88

    ec_master_queue_request_fsm_datagram(slave->master, mbox->datagram);

    89

#ifdef EC_REDUCE_MBOXFRAMESIZE

    90

    if (mbox->end_datagram.type != EC_DATAGRAM_NONE)

    91

    {

    92

        ec_master_queue_request_fsm_datagram(slave->master, &mbox->end_datagram);

    93

    }

    94

#endif

    95

}

    96

    97

    98

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

    99

   100

/**

   101

   Queues the datagrams.

   102

*/

   103

   104

void  ec_master_mbox_queue_datagrams(ec_master_t* master, /** master */

   105

                                    ec_mailbox_t* mbox /** mailbox */

   106

                                    )

   107

{

   108

    ec_master_queue_fsm_datagram(master, mbox->datagram);

   109

#ifdef EC_REDUCE_MBOXFRAMESIZE

   110

    if (mbox->end_datagram.type != EC_DATAGRAM_NONE)

   111

    {

   112

        ec_master_queue_fsm_datagram(master, &mbox->end_datagram);

   113

    }

   114

#endif

   115

}

   116

   117

   118

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

   119

   120

/**

   121

   Prepares a mailbox-send datagram.

   122

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

   123

*/

   124

   125

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

   126

                                    ec_mailbox_t* mbox, /** mailbox */

   127

                                    uint8_t type, /**< mailbox protocol */

   128

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

   129

                                    )

   130

{

   131

    ec_datagram_t* datagram = mbox->datagram;

   132

    size_t total_size;

   133

    int ret;

   134

   135

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

   136

        EC_SLAVE_ERR(slave, "Slave does not support mailbox"

   137

                " communication!\n");

   138

        return ERR_PTR(-EPROTONOSUPPORT);

   139

    }

   140

   141

    total_size = EC_MBOX_HEADER_SIZE + size;

   142

   143

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

   144

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

   145

                total_size, slave->configured_rx_mailbox_size);

   146

        return ERR_PTR(-EOVERFLOW);

   147

    }

   148

   149

    ret = ec_datagram_fpwr(datagram, slave->station_address,

   150

                           slave->configured_rx_mailbox_offset,

   151

#ifdef EC_REDUCE_MBOXFRAMESIZE

   152

                           total_size

   153

#else

   154

                           slave->configured_rx_mailbox_size

   155

#endif

   156

                           );

   157

    if (ret)

   158

        return ERR_PTR(ret);

   159

   160

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

   161

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

   162

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

   163

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

   164

   165

#ifdef EC_REDUCE_MBOXFRAMESIZE

   166

    /* in order to fulfil the ESC's mailbox protocol,

   167

       at least the last byte of the mailbox must be written */

   168

    if (total_size < slave->configured_rx_mailbox_size) {

   169

        ret = ec_datagram_fpwr(&mbox->end_datagram, slave->station_address,

   170

            slave->configured_rx_mailbox_offset+slave->configured_rx_mailbox_size-1,

   171

            1);

   172

        if (ret)

   173

            return ERR_PTR(ret);

   174

    }

   175

#endif

   176

    return datagram->data + EC_MBOX_HEADER_SIZE;

   177

}

   178

   179

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

   180

   181

/**

   182

   Prepares a datagram for checking the mailbox state.

   183

   \todo Determine sync manager used for receive mailbox

   184

   \return 0 in case of success, else < 0

   185

*/

   186

   187

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

   188

                                ec_mailbox_t* mbox /** mailbox */

   189

                                )

   190

{

   191

    ec_datagram_t* datagram = mbox->datagram;

   192

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

   193

    if (ret)

   194

        return ret;

   195

   196

    ec_datagram_zero(datagram);

   197

#ifdef EC_REDUCE_MBOXFRAMESIZE

   198

    mbox->end_datagram.type = EC_DATAGRAM_NONE;

   199

#endif

   200

    return 0;

   201

}

   202

   203

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

   204

   205

/**

   206

   Processes a mailbox state checking datagram.

   207

   \return 0 in case of success, else < 0

   208

*/

   209

   210

int ec_slave_mbox_check(ec_mailbox_t* mbox /** mailbox */)

   211

{

   212

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

   213

}

   214

   215

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

   216

   217

/**

   218

   Prepares a datagram to fetch mailbox data.

   219

   \return 0 in case of success, else < 0

   220

*/

   221

   222

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

   223

                                ec_mailbox_t* mbox /** mailbox */

   224

                                )

   225

{

   226

    ec_datagram_t* datagram = mbox->datagram;

   227

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

   228

            slave->configured_tx_mailbox_offset,

   229

            slave->configured_tx_mailbox_size);

   230

    if (ret)

   231

        return ret;

   232

   233

    ec_datagram_zero(datagram);

   234

#ifdef EC_REDUCE_MBOXFRAMESIZE

   235

    mbox->end_datagram.type = EC_DATAGRAM_NONE;

   236

#endif

   237

    return 0;

   238

}

   239

   240

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

   241

   242

/**

   243

   Mailbox error codes.

   244

*/

   245

   246

const ec_code_msg_t mbox_error_messages[] = {

   247

    {0x00000001, "MBXERR_SYNTAX"},

   248

    {0x00000002, "MBXERR_UNSUPPORTEDPROTOCOL"},

   249

    {0x00000003, "MBXERR_INVAILDCHANNEL"},

   250

    {0x00000004, "MBXERR_SERVICENOTSUPPORTED"},

   251

    {0x00000005, "MBXERR_INVALIDHEADER"},

   252

    {0x00000006, "MBXERR_SIZETOOSHORT"},

   253

    {0x00000007, "MBXERR_NOMOREMEMORY"},

   254

    {0x00000008, "MBXERR_INVALIDSIZE"},

   255

    {}

   256

};

   257

   258

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

   259

   260

/** Processes received mailbox data.

   261

 *

   262

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

   263

 */

   264

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

   265

                             ec_mailbox_t* mbox, /** mailbox */

   266

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

   267

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

   268

                             )

   269

{

   270

    ec_datagram_t* datagram = mbox->datagram;

   271

    size_t data_size;

   272

   273

    data_size = EC_READ_U16(datagram->data);

   274

   275

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

   276

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

   277

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

   278

        return ERR_PTR(-EPROTO);

   279

    }

   280

   281

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

   282

    *size = data_size;

   283

   284

    if (*type == 0x00) {

   285

        const ec_code_msg_t *mbox_msg;

   286

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

   287

   288

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

   289

   290

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

   291

            if (mbox_msg->code != code)

   292

                continue;

   293

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

   294

                    mbox_msg->code, mbox_msg->message);

   295

            break;

   296

        }

   297

   298

        if (!mbox_msg->code)

   299

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

   300

   301

        if (slave->master->debug_level)

   302

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

   303

   304

        return ERR_PTR(-EPROTO);

   305

    }

   306

   307

    return datagram->data + EC_MBOX_HEADER_SIZE;

   308

}

   309

   310

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