1

#!/usr/bin/perl

     2

     3

#------------------------------------------------------------------------------

     4

#

     5

#  l s e c  -  List EtherCAT

     6

#

     7

#  Userspace tool for listing EtherCAT slaves.

     8

#

     9

#  $Id$

    10

#

    11

#  Copyright (C) 2006  Florian Pose, Ingenieurgemeinschaft IgH

    12

#

    13

#  This file is part of the IgH EtherCAT Master.

    14

#

    15

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

    16

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

    17

#  as published by the Free Software Foundation; either version 2 of the

    18

#  License, or (at your option) any later version.

    19

#

    20

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

    21

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

    22

#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    23

#  GNU General Public License for more details.

    24

#

    25

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

    26

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

    27

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

    28

#

    29

#  The right to use EtherCAT Technology is granted and comes free of

    30

#  charge under condition of compatibility of product made by

    31

#  Licensee. People intending to distribute/sell products based on the

    32

#  code, have to sign an agreement to guarantee that products using

    33

#  software based on IgH EtherCAT master stay compatible with the actual

    34

#  EtherCAT specification (which are released themselves as an open

    35

#  standard) as the (only) precondition to have the right to use EtherCAT

    36

#  Technology, IP and trade marks.

    37

#

    38

#------------------------------------------------------------------------------

    39

    40

require 'sys/ioctl.ph';

    41

    42

use strict;

    43

use Getopt::Std;

    44

    45

my %opt;

    46

my $master_index;

    47

my $term_width;

    48

    49

#------------------------------------------------------------------------------

    50

    51

$term_width = &get_terminal_width;

    52

&get_options;

    53

&query;

    54

exit 0;

    55

    56

#------------------------------------------------------------------------------

    57

    58

sub query

    59

{

    60

    my $master_dir;

    61

    my $dirhandle;

    62

    my $entry;

    63

    my $slave_info_file;

    64

    my @slaves;

    65

    my $slave;

    66

    my $line;

    67

    my $ring_col_width;

    68

    my $alias_col_width;

    69

    my $fmt;

    70

    my $width;

    71

    my $last_alias;

    72

    my $alias_index;

    73

    my $category;

    74

    75

    $master_dir = "/sys/ethercat/master" . $master_index;

    76

    77

    unless (opendir $dirhandle, $master_dir) {

    78

        print "Failed to open directory \"$master_dir\".\n";

    79

        exit 1;

    80

    }

    81

    82

    while ($entry = readdir $dirhandle) {

    83

        next unless $entry =~ /^slave(\d+)$/;

    84

    85

        $slave = {};

    86

        $slave_info_file = "$master_dir/$entry/info"; 

    87

        open INFO, $slave_info_file or die

    88

            "ERROR: Failed to open $slave_info_file.";

    89

    90

        $category = "";

    91

        while ($line = <INFO>) {

    92

            # remember category

    93

            if ($line =~ /^([^\s][^:]*):$/) {

    94

                $category = $1;

    95

            } elsif ($line =~ /^\s*$/) {

    96

                $category = "";

    97

            }

    98

    99

            if ($category eq "") {

   100

                if ($line =~ /^Ring position: (\d+)$/) {

   101

                    $slave->{'ring_position'} = $1;

   102

                } elsif ($line =~ /^State: (.+) /) {

   103

                    $slave->{'state'} = $1;

   104

                } elsif ($line =~ /^Configured station alias: .* \((\d+)\)$/) {

   105

                    $slave->{'alias'} = $1;

   106

                } elsif ($line =~ /^Current consumption: (-?\d+) mA$/) {

   107

                    $slave->{'current'} = $1;

   108

                }

   109

            } elsif ($category eq "Identity") {

   110

                if ($line =~ /Vendor ID: .* \((\d+)\)$/) {

   111

                    $slave->{'vendor'} = $1;

   112

                } elsif ($line =~ /Product code: .* \((\d+)\)$/) {

   113

                    $slave->{'product'} = $1;

   114

                }

   115

            } elsif ($category eq "General") {

   116

                if ($line =~ /Name: (.*)$/) {

   117

                    $slave->{'name'} = $1;

   118

                }

   119

            }

   120

        }

   121

   122

        close INFO;

   123

        push @slaves, $slave;

   124

    }

   125

    closedir $dirhandle;

   126

   127

    @slaves = sort { $a->{'ring_position'} <=> $b->{'ring_position'} } @slaves;

   128

   129

    # create field addresses and calculate column widths

   130

    $ring_col_width = 0;

   131

    $alias_col_width = 0;

   132

    $last_alias = "";

   133

    for $slave (@slaves) {

   134

        if ($slave->{'alias'}) {

   135

            $last_alias = $slave->{'alias'};

   136

            $alias_index = 0;

   137

        }

   138

        if ($last_alias) {

   139

            $slave->{'field_address'} = "#" . $last_alias . ":" . $alias_index;

   140

            $width = length $slave->{'field_address'};

   141

            $alias_col_width = $width if ($width > $alias_col_width);

   142

        }

   143

        $width = length $slave->{'ring_position'};

   144

        $ring_col_width = $width if ($width > $ring_col_width);

   145

        $alias_index++;

   146

    }

   147

   148

    # replace empty name with vendor id and product code

   149

    for $slave (@slaves) {

   150

        unless (defined $slave->{'name'}) {

   151

            $slave->{'name'} = sprintf("0x%08X:0x%08X", $slave->{'vendor'},

   152

                    $slave->{'product'});

   153

        }

   154

    }

   155

   156

    if (defined $opt{'c'}) { # display power consumtion

   157

        $fmt = sprintf " %%%is  %%%is  %%6i  %%6i  %%s\n",

   158

            $ring_col_width, $alias_col_width;

   159

   160

        my $current_sum = 0;

   161

        for $slave (@slaves) {

   162

            &print_line if $slave->{'alias'} and !defined $opt{n};

   163

            $current_sum = 0 if $slave->{'current'} < 0;

   164

            $current_sum -= $slave->{'current'};

   165

            printf($fmt, $slave->{'ring_position'}, $slave->{'field_address'},

   166

                    $slave->{'current'}, $current_sum, $slave->{'name'});

   167

        }

   168

    }

   169

    else { # normal display

   170

        $fmt = sprintf " %%%is  %%%is  %%-6s  %%s\n",

   171

            $ring_col_width, $alias_col_width;

   172

   173

        for $slave (@slaves) {

   174

            &print_line if $slave->{'alias'} and !defined $opt{n};

   175

            printf($fmt, $slave->{'ring_position'}, $slave->{'field_address'},

   176

                    $slave->{'state'}, $slave->{'name'});

   177

        }

   178

    }

   179

}

   180

   181

#------------------------------------------------------------------------------

   182

   183

sub get_options

   184

{

   185

    my $optret = getopts "m:cnh", \%opt;

   186

   187

    &print_usage if defined $opt{h} or $#ARGV > -1 or !$optret;

   188

   189

    if (defined $opt{m}) {

   190

        $master_index = $opt{m};

   191

    }

   192

    else {

   193

        $master_index = 0;

   194

    }

   195

}

   196

   197

#------------------------------------------------------------------------------

   198

   199

sub print_usage

   200

{

   201

    my $cmd = `basename $0`;

   202

    chomp $cmd;

   203

    print "Usage: $cmd [OPTIONS]\n";

   204

    print "        -m <IDX>    Query master <IDX>.\n";

   205

    print "        -c          Display current [mA] ";

   206

    print "(3: consumption, 4: remaining).\n";

   207

    print "        -n          Do not display lines before aliased slaves.\n";

   208

    print "        -h          Show this help.\n";

   209

    exit 0;

   210

}

   211

   212

#------------------------------------------------------------------------------

   213

   214

sub get_terminal_width

   215

{

   216

    my $winsize;

   217

    die "no TIOCGWINSZ " unless defined &TIOCGWINSZ;

   218

    open(TTY, "+</dev/tty") or die "No tty: $!";

   219

    unless (ioctl(TTY, &TIOCGWINSZ, $winsize='')) {

   220

        die sprintf "$0: ioctl TIOCGWINSZ (%08x: $!)\n", &TIOCGWINSZ;

   221

    }

   222

    (my $row, my $col, my $xpixel, my $ypixel) = unpack('S4', $winsize);

   223

    return $col;

   224

}

   225

#------------------------------------------------------------------------------

   226

   227

sub print_line

   228

{

   229

    for (my $i = 0; $i < $term_width; $i++) {

   230

        print "-";

   231

    }

   232

    print "\n";

   233

}

   234

   235

#------------------------------------------------------------------------------