mirror of
https://github.com/kubernetes-sigs/node-feature-discovery.git
synced 2025-03-16 21:38:23 +00:00
d857f88d2d
In my homelab, I have different FTDI serial converters connected to several utility meters. They all have identical vendor/device, but different serials. In order to detect a specific FTDI unit (eg. the one connected to my electricity meter), I'd like feature labels triggered by a specific USB serial. Signed-off-by: Jorik Jonker <jorik@kippendief.biz>
83 lines
2.2 KiB
Go
83 lines
2.2 KiB
Go
/*
|
|
Copyright 2020 The Kubernetes Authors.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
|
|
package rules
|
|
|
|
import (
|
|
"fmt"
|
|
usbutils "sigs.k8s.io/node-feature-discovery/source/internal"
|
|
)
|
|
|
|
// Rule that matches on the following USB device attributes: <class, vendor, device>
|
|
// each device attribute will be a list elements(strings).
|
|
// Match operation: OR will be performed per element and AND will be performed per attribute.
|
|
// An empty attribute will not be included in the matching process.
|
|
type UsbIDRuleInput struct {
|
|
Class []string `json:"class,omitempty"`
|
|
Vendor []string `json:"vendor,omitempty"`
|
|
Device []string `json:"device,omitempty"`
|
|
Serial []string `json:"serial,omitempty"`
|
|
}
|
|
|
|
type UsbIDRule struct {
|
|
UsbIDRuleInput
|
|
}
|
|
|
|
// Match USB devices on provided USB device attributes
|
|
func (r *UsbIDRule) Match() (bool, error) {
|
|
devAttr := map[string]bool{}
|
|
for _, attr := range []string{"class", "vendor", "device", "serial"} {
|
|
devAttr[attr] = true
|
|
}
|
|
allDevs, err := usbutils.DetectUsb(devAttr)
|
|
if err != nil {
|
|
return false, fmt.Errorf("failed to detect USB devices: %s", err.Error())
|
|
}
|
|
|
|
for _, classDevs := range allDevs {
|
|
for _, dev := range classDevs {
|
|
// match rule on a single device
|
|
if r.matchDevOnRule(dev) {
|
|
return true, nil
|
|
}
|
|
}
|
|
}
|
|
return false, nil
|
|
}
|
|
|
|
func (r *UsbIDRule) matchDevOnRule(dev usbutils.UsbDeviceInfo) bool {
|
|
if len(r.Class) == 0 && len(r.Vendor) == 0 && len(r.Device) == 0 {
|
|
return false
|
|
}
|
|
|
|
if len(r.Class) > 0 && !in(dev["class"], r.Class) {
|
|
return false
|
|
}
|
|
|
|
if len(r.Vendor) > 0 && !in(dev["vendor"], r.Vendor) {
|
|
return false
|
|
}
|
|
|
|
if len(r.Device) > 0 && !in(dev["device"], r.Device) {
|
|
return false
|
|
}
|
|
|
|
if len(r.Serial) > 0 && !in(dev["serial"], r.Serial) {
|
|
return false
|
|
}
|
|
|
|
return true
|
|
}
|