blob: 57c82a2ab4819532cad5769a817f6e003e3aaeed [file] [log] [blame]
Matt Spinler8df7be82017-01-09 15:42:05 -06001package Util;
2
3#Holds common utility functions for MRW processing.
4
5use strict;
6use warnings;
7
8use mrw::Targets;
9
10#Returns the BMC target for a system.
11# param[in] $targetObj = The Targets object
12sub getBMCTarget
13{
14 my ($targetObj) = @_;
15
16 for my $target (keys %{$targetObj->getAllTargets()}) {
17 if ($targetObj->getType($target) eq "BMC") {
18 return $target;
19 }
20 }
21
22 die "Could not find BMC target in the MRW XML\n";
23}
24
25
26#Returns an array of child units based on their Target Type.
27# param[in] $targetObj = The Targets object
28# param[in] $unitTargetType = The target type of the units to find
29# param[in] $chip = The chip target to find the units on
30sub getChildUnitsWithTargetType
31{
32 my ($targetObj, $unitTargetType, $chip) = @_;
33 my @units;
34
35 my @children = $targetObj->getAllTargetChildren($chip);
36
37 for my $child (@children) {
38 if ($targetObj->getTargetType($child) eq $unitTargetType) {
39 push @units, $child;
40 }
41 }
42
43 return @units;
44}
45
Marri Devender Rao694e8dc2018-03-12 09:21:29 -050046#Returns size of child units based on their Type.
47# param[in] $targetObj = The Targets object
48# param[in] $type = The type of the units to find
49# param[in] $chip = The chip target to find the units on
50sub getSizeOfChildUnitsWithType
51{
52 my ($targetObj, $type, $chip) = @_;
53 my @units;
54 my @children = $targetObj->getAllTargetChildren($chip);
55 for my $child (@children) {
56 if ($targetObj->getType($child) eq $type) {
57 push @units, $child;
58 }
59 }
60 my $size = @units;
61 return $size;
62}
63
Deepak Kodihalli6225e932017-02-07 12:14:55 -060064# Returns OBMC name corresponding to a Target name
65# param[in] \@inventory = reference to array of inventory items
66# param[in] $targetName = A Target name
67sub getObmcName
68{
69 my ($inventory_ref, $targetName) = @_;
70 my @inventory = @{ $inventory_ref };
71
72 for my $item (@inventory)
73 {
74 if($item->{TARGET} eq $targetName)
75 {
76 return $item->{OBMC_NAME};
77 }
78 }
79 return undef;
80}
81
Ratan Guptad92101d2017-02-15 19:40:39 +053082#Returns the array of all the device paths based on the type.
83# param[in] \@inventory = reference to array of inventory items.
84# param[in] $targetObj = The Targets object.
85# param[in] $type = The target type.
86sub getDevicePath
87{
88 my ($inventory_ref, $targetObj, $type) = @_;
89 my @inventory = @{ $inventory_ref };
90 my $fruType = "";
91 my @devices;
92 for my $item (@inventory)
93 {
94 if (!$targetObj->isBadAttribute($item->{TARGET}, "TYPE")) {
95 $fruType = $targetObj->getAttribute($item->{TARGET}, "TYPE");
96 if ($fruType eq $type) {
97 push(@devices,$item->{OBMC_NAME});
98 }
99 }
100 }
101 return @devices;
102}
103
Deepak Kodihallic1b12a42017-02-22 04:00:54 -0600104#Convert the MRW I2C address into the standard 7-bit format
105# $addr = the I2C Address
106sub adjustI2CAddress
107{
108 my $addr = shift;
109
110 #MRW holds the 8 bit value. We need the 7 bit one.
111 $addr = $addr >> 1;
112 $addr = sprintf("0x%X", $addr);
113 $addr = lc $addr;
114
115 return $addr;
116}
Ratan Guptad92101d2017-02-15 19:40:39 +0530117
Deepak Kodihalli9283add2017-02-22 04:14:01 -0600118#Return nearest FRU enclosing the input target
119# $targets = the Targets object
120# $targetName = the target name
121sub getEnclosingFru
122{
123 my ($targets, $targetName) = @_;
124
125 if (($targetName eq "") || (!defined $targetName))
126 {
127 return "";
128 }
129
130 if (!$targets->isBadAttribute($targetName, "RU_TYPE"))
131 {
132 my $ruType = $targets->getAttribute($targetName, "RU_TYPE");
133 if (($ruType eq "FRU") || ($ruType eq "CRU"))
134 {
135 return $targetName;
136 }
137 }
138
139 my $parent = $targets->getTargetParent($targetName);
140 return getEnclosingFru($targets, $parent);
141}
142
Deepak Kodihalli8f5dec52017-02-23 02:42:15 -0600143#Convert I2C port number from MRW scheme to Linux numbering scheme
144# $port = the I2C port number
145sub adjustI2CPort
146{
147 my $port = shift;
148
149 return $port - 1;
150}
151
Matt Spinler8df7be82017-01-09 15:42:05 -06001521;
153
154=head1 NAME
155
156Util
157
158=head1 DESCRIPTION
159
160Contains utility functions for the MRW parsers.
161
162=head1 METHODS
163
164=over 4
165
166=item getBMCTarget(C<TargetsObj>)
167
168Returns the target string for the BMC chip. If it can't find one,
169it will die. Currently supports single BMC systems.
170
171=item getChildUnitsWithTargetType(C<TargetsObj>, C<TargetType>, C<ChipTarget>)
172
173Returns an array of targets that have target-type C<TargetType>
174and are children (any level) of target C<ChipTarget>.
175
Marri Devender Rao694e8dc2018-03-12 09:21:29 -0500176=item getSizeOfChildUnitsWithType(C<TargetsObj>, C<Type>, C<ChipTarget>)
177
178Returns size of targets that have Type C<Type>
179and are children (any level) of target C<ChipTarget>.
180
Deepak Kodihalli6225e932017-02-07 12:14:55 -0600181=item getObmcName(C<InventoryItems>, C<TargetName>)
182
183Returns an OBMC name corresponding to a Target name. Returns
184undef if the Target name is not found.
185
Ratan Guptad92101d2017-02-15 19:40:39 +0530186=item getDevicePath(C<InventoryItems>, C<TargetsObj>, C<TargetType>)
Deepak Kodihalli6474db82017-02-22 04:40:06 -0600187
188Returns an array of all device paths (OBMC names) based on C<TargetType>.
Ratan Guptad92101d2017-02-15 19:40:39 +0530189
Deepak Kodihallic1b12a42017-02-22 04:00:54 -0600190=item adjustI2CAddress(C<I2CAddress>)
191
192Returns C<I2CAddress> converted from MRW format (8-bit) to the standard 7-bit
193format.
194
Deepak Kodihalli9283add2017-02-22 04:14:01 -0600195=item getEnclosingFru(C<TargetsObj>, C<Target>)
196
197Finds the nearest FRU enclosing the input Target.
198
Deepak Kodihalli8f5dec52017-02-23 02:42:15 -0600199=item adjustI2CPort(C<I2CPort>)
200
201Returns C<I2CPort> converted from MRW numering scheme to Linux numbering scheme.
202
Matt Spinler8df7be82017-01-09 15:42:05 -0600203=back
204
205=cut