Debian Codegraph @

xpp/perl_modules/Dahdi/Xpp/Mpp.pm

raw
1 package Dahdi::Xpp::Mpp;
2 #
3 # Written by Oron Peled <[email protected]>
4 # Copyright (C) 2009, Xorcom
5 # This program is free software; you can redistribute and/or
6 # modify it under the same terms as Perl itself.
7 #
8 # $Id$
9 #
10 use strict;
11 use File::Basename;
12 use Getopt::Std;
13 BEGIN { my $dir = dirname($0); unshift(@INC, "$dir", "$dir/perl_modules"); }
14
15 use Dahdi::Utils;
16
17 =head1 NAME
18
19 Dahdi::Xpp::Mpp - Perl interface to C<astribank_tool(8)>
20
21 =head1 DESCRIPTION
22
23 This package uses C<astribank_tool(8)> to collect information
24 about Astribanks via MPP (Management Processor Protocol).
25
26 The binary default location is F</usr/sbin/astribank_tool>. It may be
27 overridden via module parameter C<astribank_tool=> and the
28 C<ASTRIBANK_TOOL> environment variable (higher priority).
29
30 It may also be set/unset from code via the set_astribank_tool() method.
31
32 =head1 METHODS
33
34 =head2 mpp_addinfo()
35
36 Called with a list of C<Dahdi::Hardware> objects and augment their
37 data with C<Dahdi::Xpp::Mpp> objects.
38
39 This method is the normal external interface of this class.
40
41 =head2 new()
42
43 Constructor. Receive as parameter an instance of C<Dahdi::Hardware> class
44 and return a C<Dahdi::Xpp:Mpp> object.
45
46 Normally, used indirectly via the mpp_addinfo() method.
47
48 =head2 set_astribank_tool()
49
50 Override default location of astribank_tool(8). It is legal
51 to set it to C<undef>.
52
53 =head2 showinfo()
54
55 Dump an C<Dahdi::Xpp::Mpp> object for debugging.
56
57 =cut
58
59 my $astribank_tool = '/usr/sbin/astribank_tool';
60
61 sub set_astribank_tool($$) {
62 my $pack = shift || die;
63 $pack eq 'Dahdi::Xpp::Mpp' or die "$0: Called from wrong package? ($pack)";
64 my $arg = shift;
65 $astribank_tool = $arg;
66 #print STDERR "Setting astribank_tool='$astribank_tool'\n";
67 }
68
69 sub import {
70 my ($param) = grep(/^astribank_tool=/, @_);
71 if(defined $param) {
72 $param =~ s/^astribank_tool=//;
73 $astribank_tool = $param;
74 }
75 if(defined $ENV{ASTRIBANK_TOOL}) {
76 $astribank_tool = $ENV{ASTRIBANK_TOOL};
77 }
78 }
79
80 sub showinfo($$) {
81 my $self = shift || die;
82 my $prefix = shift || die;
83
84 return unless defined $self;
85 foreach my $k (sort keys %{$self}) {
86 my $v = $self->{$k};
87 if(ref($v) eq 'ARRAY') {
88 my @a = @{$v};
89 my $i;
90 my $ki;
91 for($i = 0; $i < @a; $i++) {
92 $ki = sprintf "%s[%d]", $k, $i;
93 printf "$prefix%-20s %s\n", $ki, $a[$i];
94 }
95 } else {
96 if($k eq 'DEV') {
97 printf "$prefix%-20s -> %s\n", $k, $v->hardware_name;
98 } else {
99 printf "$prefix%-20s %s\n", $k, $v;
100 }
101 }
102 }
103 }
104
105 sub astribank_tool_cmd($@) {
106 my $dev = shift || die;
107 my @args = @_;
108 my $usb_top;
109
110 # Find USB bus toplevel
111 $usb_top = '/dev/bus/usb';
112 $usb_top = '/proc/bus/usb' unless -d $usb_top;
113 die "No USB toplevel found\n" unless -d $usb_top;
114 my $name = $dev->priv_device_name();
115 die "$0: Unkown private device name" unless defined $name;
116 my $path = "$usb_top/$name";
117 return ($astribank_tool, '-D', "$path", @args);
118 }
119
120 sub new($$$) {
121 my $pack = shift || die;
122 my $dev = shift || die;
123 my $product = $dev->product;
124
125 return undef unless $dev->is_astribank;
126 return undef unless $dev->bus_type eq 'USB';
127 return undef unless $product =~ /116./;
128 my $mppinfo = {
129 DEV => $dev,
130 HAS_MPP => 1,
131 };
132 bless $mppinfo, $pack;
133 #print STDERR "$astribank_tool($path) -- '$product'\n";
134 if(! -x $astribank_tool) {
135 warn "Could not run '$astribank_tool'\n";
136 return $mppinfo;
137 }
138 return $mppinfo unless $product =~ /116[12]/;
139 $mppinfo->{'MPP_TALK'} = 1;
140 my @cmd = astribank_tool_cmd($dev, '-Q');
141 my $name = $dev->priv_device_name();
142 my $dbg_file = "$name";
143 $dbg_file =~ s/\W/_/g;
144 #$dbg_file = "/tmp/twinstar-debug-$dbg_file";
145 $dbg_file = "/dev/null";
146 unless(open(F, "@cmd 2> '$dbg_file' |")) {
147 warn "Failed running '$astribank_tool': $!";
148 return undef;
149 }
150 local $/ = "\n";
151 local $_;
152 while(<F>) {
153 chomp;
154 #printf STDERR "'%s'\n", $_;
155 if(s/^INFO:\s*//) {
156 $mppinfo->{'PROTOCOL'} = $1 if /^protocol\s+version:\s*(\d+)/i;
157 } elsif(s/^EEPROM:\s*//) {
158 $mppinfo->{'EEPROM_RELEASE'} = $1 if /^release\s*:\s*([\d\.]+)/i;
159 $mppinfo->{'EEPROM_LABEL'} = $1 if /^label\s*:\s*([\w._'-]+)/i;
160 } elsif(s/^Extrainfo:\s+:\s*(.+?)$//) {
161 $mppinfo->{'EEPROM_EXTRAINFO'} = $1;
162 } elsif(s/^Capabilities:\s*TwinStar\s*:\s*(.+?)$//) {
163 my $cap = $1;
164 $mppinfo->{'TWINSTAR_CAPABLE'} = ($cap =~ /yes/i) ? 1 : 0;
165 } elsif(s/^TwinStar:\s*//) {
166 $mppinfo->{'TWINSTAR_PORT'} = $1 if /^connected\s+to\s*:\s*usb-(\d+)/i;
167 if(s/^USB-(\d+)\s*POWER\s*:\s*//) {
168 my $v = ($_ eq 'ON') ? 1 : 0;
169 $mppinfo->{'TWINSTAR_POWER'}->[$1] = $v;
170 }
171 if(s/^Watchdog[^:]+:\s*//) {
172 my $v = ($_ eq 'on-guard') ? 1 : 0;
173 $mppinfo->{'TWINSTAR_WATCHDOG'} = $v;
174 }
175 #printf STDERR "\t%s\n", $_;
176 } else {
177 #printf STDERR "\t%s\n", $_;
178 }
179 }
180 unless(close F) {
181 warn "Failed running '$astribank_tool': $!";
182 return undef;
183 }
184 #$mppinfo->showinfo;
185 return $mppinfo;
186 }
187
188 sub mpp_setwatchdog($$) {
189 my $mppinfo = shift || die;
190 my $on = shift;
191 die "$0: Bad value '$on'" unless defined($on) && $on =~ /^[0-1]$/;
192 my $dev = $mppinfo->dev || die;
193 return undef unless defined $mppinfo->mpp_talk;
194 my $old = $mppinfo->tws_watchdog;
195 my @cmd = astribank_tool_cmd($dev, '-w', $on);
196 print STDERR "DEBUG($on): '@cmd'\n";
197 system(@cmd);
198 die "Running $astribank_tool failed: $?" if $?;
199 }
200
201 sub mpp_jump($) {
202 my $mppinfo = shift || die;
203 my $dev = $mppinfo->dev || die;
204 return undef unless defined $mppinfo->mpp_talk;
205 my $port = $mppinfo->twinstar_port;
206 $port = ($port == 1) ? 0 : 1;
207 die "Unknown TwinStar port" unless defined $port;
208 my @cmd = astribank_tool_cmd($dev, '-p', $port);
209 system(@cmd);
210 die "Running $astribank_tool failed: $?" if $?;
211 }
212
213 sub mpp_addinfo($@) {
214 my $pack = shift || die;
215 my @devlist = @_;
216
217 foreach my $dev (@devlist) {
218 $dev->{MPPINFO} = $pack->new($dev);
219 }
220 }
221
222 1;