1

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

     2

 *

     3

 *  m a i l b o x . c

     4

 *

     5

 *  Mailbox functionality.

     6

 *

     7

 *  $Id$

     8

 *

     9

 *  Copyright (C) 2006  Florian Pose, Ingenieurgemeinschaft IgH

    10

 *

    11

 *  This file is part of the IgH EtherCAT Master.

    12

 *

    13

 *  The IgH EtherCAT Master is free software; you can redistribute it

    14

 *  and/or modify it under the terms of the GNU General Public License

    15

 *  as published by the Free Software Foundation; version 2 of the License.

    16

 *

    17

 *  The IgH EtherCAT Master is distributed in the hope that it will be

    18

 *  useful, but WITHOUT ANY WARRANTY; without even the implied warranty of

    19

 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    20

 *  GNU General Public License for more details.

    21

 *

    22

 *  You should have received a copy of the GNU General Public License

    23

 *  along with the IgH EtherCAT Master; if not, write to the Free Software

    24

 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

    25

 *

    26

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

    27

    28

#include <linux/slab.h>

    29

#include <linux/delay.h>

    30

    31

#include "mailbox.h"

    32

#include "command.h"

    33

#include "master.h"

    34

    35

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

    36

    37

/**

    38

   Prepares a mailbox-send command.

    39

   \return pointer to mailbox command data

    40

   \ingroup Slave

    41

*/

    42

    43

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

    44

                                    uint8_t type, /**< mailbox protocol */

    45

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

    46

                                    )

    47

{

    48

    ec_command_t *command = &slave->mbox_command;

    49

    size_t total_size;

    50

    51

    if (unlikely(!slave->sii_mailbox_protocols)) {

    52

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

    53

               slave->ring_position);

    54

        return NULL;

    55

    }

    56

    57

    total_size = size + 6;

    58

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

    59

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

    60

        return NULL;

    61

    }

    62

    63

    if (ec_command_npwr(command, slave->station_address,

    64

                        slave->sii_rx_mailbox_offset,

    65

                        slave->sii_rx_mailbox_size))

    66

        return NULL;

    67

    68

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

    69

    EC_WRITE_U16(command->data + 2, slave->station_address); // station address

    70

    EC_WRITE_U8 (command->data + 4, 0x00); // hhannel & priority

    71

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

    72

    73

    return command->data + 6;

    74

}

    75

    76

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

    77

    78

/**

    79

   Prepares a command for checking the mailbox state.

    80

   \return 0 in case of success, else < 0

    81

   \ingroup Slave

    82

*/

    83

    84

int ec_slave_mbox_prepare_check(ec_slave_t *slave /**< slave */)

    85

{

    86

    ec_command_t *command = &slave->mbox_command;

    87

    88

    // FIXME: second sync manager?

    89

    if (ec_command_nprd(command, slave->station_address, 0x808, 8))

    90

        return -1;

    91

    92

    return 0;

    93

}

    94

    95

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

    96

    97

/**

    98

   Processes a mailbox state checking command.

    99

   \return 0 in case of success, else < 0

   100

   \ingroup Slave

   101

*/

   102

   103

int ec_slave_mbox_check(const ec_slave_t *slave /**< slave */)

   104

{

   105

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

   106

}

   107

   108

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

   109

   110

/**

   111

   Prepares a command to fetch mailbox data.

   112

   \return 0 in case of success, else < 0

   113

   \ingroup Slave

   114

*/

   115

   116

int ec_slave_mbox_prepare_fetch(ec_slave_t *slave /**< slave */)

   117

{

   118

    ec_command_t *command = &slave->mbox_command;

   119

   120

    if (ec_command_nprd(command, slave->station_address,

   121

                        slave->sii_tx_mailbox_offset,

   122

                        slave->sii_tx_mailbox_size)) return -1;

   123

    return 0;

   124

}

   125

   126

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

   127

   128

/**

   129

   Processes received mailbox data.

   130

   \return pointer to the received data

   131

   \ingroup Slave

   132

*/

   133

   134

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

   135

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

   136

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

   137

                             )

   138

{

   139

    ec_command_t *command = &slave->mbox_command;

   140

    size_t data_size;

   141

   142

    if ((EC_READ_U8(command->data + 5) & 0x0F) != type) {

   143

        EC_ERR("Unexpected mailbox protocol 0x%02X (exp.: 0x%02X) at"

   144

               " slave %i!\n", EC_READ_U8(command->data + 5), type,

   145

               slave->ring_position);

   146

        return NULL;

   147

    }

   148

   149

    if ((data_size = EC_READ_U16(command->data)) >

   150

        slave->sii_tx_mailbox_size - 6) {

   151

        EC_ERR("Currupt mailbox response detected!\n");

   152

        return NULL;

   153

    }

   154

   155

    *size = data_size;

   156

    return command->data + 6;

   157

}

   158

   159

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

   160

   161

/**

   162

   Sends a mailbox command and waits for its reception.

   163

   \return pointer to the received data

   164

   \ingroup Slave

   165

*/

   166

   167

uint8_t *ec_slave_mbox_simple_io(ec_slave_t *slave, /**< slave */

   168

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

   169

                                 )

   170

{

   171

    uint8_t type;

   172

    ec_command_t *command;

   173

   174

    command = &slave->mbox_command;

   175

    type = EC_READ_U8(command->data + 5);

   176

   177

    if (unlikely(ec_master_simple_io(slave->master, command))) {

   178

        EC_ERR("Mailbox checking failed on slave %i!\n",

   179

               slave->ring_position);

   180

        return NULL;

   181

    }

   182

   183

    return ec_slave_mbox_simple_receive(slave, type, size);

   184

}

   185

   186

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

   187

   188

/**

   189

   Waits for the reception of a mailbox command.

   190

   \return pointer to the received data

   191

   \ingroup Slave

   192

*/

   193

   194

uint8_t *ec_slave_mbox_simple_receive(ec_slave_t *slave, /**< slave */

   195

                                      uint8_t type, /**< expected protocol */

   196

                                      size_t *size /**< received data size */

   197

                                      )

   198

{

   199

    cycles_t start, end, timeout;

   200

    ec_command_t *command;

   201

   202

    command = &slave->mbox_command;

   203

    start = get_cycles();

   204

    timeout = (cycles_t) 100 * cpu_khz; // 100ms

   205

   206

    while (1)

   207

    {

   208

        if (ec_slave_mbox_prepare_check(slave)) return NULL;

   209

        if (unlikely(ec_master_simple_io(slave->master, command))) {

   210

            EC_ERR("Mailbox checking failed on slave %i!\n",

   211

                   slave->ring_position);

   212

            return NULL;

   213

        }

   214

   215

        end = get_cycles();

   216

   217

        if (ec_slave_mbox_check(slave))

   218

            break; // proceed with receiving data

   219

   220

        if ((end - start) >= timeout) {

   221

            EC_ERR("Mailbox check - Slave %i timed out.\n",

   222

                   slave->ring_position);

   223

            return NULL;

   224

        }

   225

   226

        udelay(100);

   227

    }

   228

   229

    if (ec_slave_mbox_prepare_fetch(slave)) return NULL;

   230

    if (unlikely(ec_master_simple_io(slave->master, command))) {

   231

        EC_ERR("Mailbox receiving failed on slave %i!\n",

   232

               slave->ring_position);

   233

        return NULL;

   234

    }

   235

   236

    if (unlikely(slave->master->debug_level) > 1)

   237

        EC_DBG("Mailbox receive took %ius.\n", ((u32) (end - start) * 1000

   238

                                                / cpu_khz));

   239

   240

    return ec_slave_mbox_fetch(slave, type, size);

   241

}

   242

   243

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