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 @slaves;

    64

    my $slave;

    65

    my $abs;

    66

    my $line;

    67

    my $ring_cols;

    68

    my $adv_cols;

    69

    my $fmt;

    70

    my $cols;

    71

    72

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

    73

    74

    unless (opendir $dirhandle, $master_dir) {

    75

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

    76

		exit 1;

    77

    }

    78

    79

    while ($entry = readdir $dirhandle) {

    80

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

    81

    82

		$slave = {};

    83

    84

		open INFO, "$master_dir/$entry/info" or die

    85

			"ERROR: Failed to open $master_dir/$entry/info";

    86

    87

		while ($line = <INFO>) {

    88

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

    89

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

    90

			}

    91

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

    92

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

    93

			}

    94

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

    95

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

    96

			}

    97

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

    98

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

    99

			}

   100

			elsif ($line =~ /^Coupler: ([a-z]+)$/) {

   101

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

   102

			}

   103

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

   104

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

   105

			}

   106

		}

   107

   108

		close INFO;

   109

   110

		push @slaves, $slave;

   111

    }

   112

    closedir $dirhandle;

   113

   114

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

   115

   116

    $ring_cols = 0;

   117

    $adv_cols = 0;

   118

    for $slave (@slaves) {

   119

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

   120

	$ring_cols = $cols if ($cols > $ring_cols);

   121

	$cols = length $slave->{'advanced_position'};

   122

	$adv_cols = $cols if ($cols > $adv_cols);

   123

    }

   124

   125

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

   126

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

   127

	    $ring_cols, $adv_cols;

   128

   129

	my $current_sum = 0;

   130

	for $slave (@slaves) {

   131

	    if ($slave->{'coupler'} eq "yes") {

   132

		&print_line if !defined $opt{n};

   133

		$current_sum = 0; # reset current sum

   134

	    }

   135

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

   136

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

   137

		   $slave->{'advanced_position'}, $slave->{'current'},

   138

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

   139

	}

   140

    }

   141

    else {

   142

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

   143

   144

	for $slave (@slaves) {

   145

	    &print_line if $slave->{'coupler'} eq "yes" and !defined $opt{n};

   146

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

   147

		   $slave->{'advanced_position'}, $slave->{'state'},

   148

		   $slave->{'name'});

   149

	}

   150

    }

   151

}

   152

   153

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

   154

   155

sub get_options

   156

{

   157

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

   158

   159

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

   160

   161

    if (defined $opt{m}) {

   162

	$master_index = $opt{m};

   163

    }

   164

    else {

   165

	$master_index = 0;

   166

    }

   167

}

   168

   169

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

   170

   171

sub print_usage

   172

{

   173

    my $cmd = `basename $0`;

   174

    chomp $cmd;

   175

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

   176

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

   177

    print "        -c          Display current [mA] ";

   178

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

   179

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

   180

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

   181

    exit 0;

   182

}

   183

   184

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

   185

   186

sub get_terminal_width

   187

{

   188

    my $winsize;

   189

    die "no TIOCGWINSZ " unless defined &TIOCGWINSZ;

   190

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

   191

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

   192

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

   193

    }

   194

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

   195

    return $col;

   196

}

   197

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

   198

   199

sub print_line

   200

{

   201

    for (my $i = 0; $i < $term_width; $i++) {print "-";}

   202

    print "\n";

   203

}

   204

   205

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