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 $abs;

    67

    my $line;

    68

    my $ring_col_width;

    69

    my $alias_col_width;

    70

    my $fmt;

    71

    my $width;

    72

    my $last_alias;

    73

    my $alias_index;

    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

        while ($line = <INFO>) {

    91

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

    92

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

    93

            }

    94

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

    95

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

    96

            }

    97

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

    98

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

    99

            }

   100

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

   101

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

   102

            }

   103

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

   104

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

   105

            }

   106

        }

   107

   108

        close INFO;

   109

        push @slaves, $slave;

   110

    }

   111

    closedir $dirhandle;

   112

   113

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

   114

   115

    # create field addresses and calculate column widths

   116

    $ring_col_width = 0;

   117

    $alias_col_width = 0;

   118

    $last_alias = "";

   119

    for $slave (@slaves) {

   120

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

   121

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

   122

            $alias_index = 0;

   123

        }

   124

        if ($last_alias) {

   125

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

   126

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

   127

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

   128

        }

   129

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

   130

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

   131

        $alias_index++;

   132

    }

   133

   134

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

   135

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

   136

            $ring_col_width, $alias_col_width;

   137

   138

        my $current_sum = 0;

   139

        for $slave (@slaves) {

   140

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

   141

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

   142

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

   143

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

   144

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

   145

        }

   146

    }

   147

    else { # normal display

   148

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

   149

            $ring_col_width, $alias_col_width;

   150

   151

        for $slave (@slaves) {

   152

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

   153

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

   154

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

   155

        }

   156

    }

   157

}

   158

   159

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

   160

   161

sub get_options

   162

{

   163

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

   164

   165

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

   166

   167

    if (defined $opt{m}) {

   168

        $master_index = $opt{m};

   169

    }

   170

    else {

   171

        $master_index = 0;

   172

    }

   173

}

   174

   175

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

   176

   177

sub print_usage

   178

{

   179

    my $cmd = `basename $0`;

   180

    chomp $cmd;

   181

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

   182

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

   183

    print "        -c          Display current [mA] ";

   184

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

   185

    print "        -n          Display no coupler lines.\n";

   186

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

   187

    exit 0;

   188

}

   189

   190

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

   191

   192

sub get_terminal_width

   193

{

   194

    my $winsize;

   195

    die "no TIOCGWINSZ " unless defined &TIOCGWINSZ;

   196

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

   197

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

   198

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

   199

    }

   200

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

   201

    return $col;

   202

}

   203

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

   204

   205

sub print_line

   206

{

   207

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

   208

        print "-";

   209

    }

   210

    print "\n";

   211

}

   212

   213

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