oshi.hardware.platform.unix.freebsd.FreeBsdUsbDevice Maven / Gradle / Ivy
/**
* MIT License
*
* Copyright (c) 2010 - 2021 The OSHI Project Contributors: https://github.com/oshi/oshi/graphs/contributors
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
package oshi.hardware.platform.unix.freebsd;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import oshi.annotation.concurrent.Immutable;
import oshi.hardware.UsbDevice;
import oshi.hardware.common.AbstractUsbDevice;
import oshi.util.ExecutingCommand;
import oshi.util.ParseUtil;
/**
* FreeBsd Usb Device
*/
@Immutable
public class FreeBsdUsbDevice extends AbstractUsbDevice {
public FreeBsdUsbDevice(String name, String vendor, String vendorId, String productId, String serialNumber,
String uniqueDeviceId, List connectedDevices) {
super(name, vendor, vendorId, productId, serialNumber, uniqueDeviceId, connectedDevices);
}
/**
* Instantiates a list of {@link oshi.hardware.UsbDevice} objects, representing
* devices connected via a usb port (including internal devices).
*
* If the value of {@code tree} is true, the top level devices returned from
* this method are the USB Controllers; connected hubs and devices in its device
* tree share that controller's bandwidth. If the value of {@code tree} is
* false, USB devices (not controllers) are listed in a single flat list.
*
* @param tree
* If true, returns a list of controllers, which requires recursive
* iteration of connected devices. If false, returns a flat list of
* devices excluding controllers.
* @return a list of {@link oshi.hardware.UsbDevice} objects.
*/
public static List getUsbDevices(boolean tree) {
List devices = getUsbDevices();
if (tree) {
return devices;
}
List deviceList = new ArrayList<>();
// Top level is controllers; they won't be added to the list, but all
// their connected devices will be
for (UsbDevice device : devices) {
deviceList.add(new FreeBsdUsbDevice(device.getName(), device.getVendor(), device.getVendorId(),
device.getProductId(), device.getSerialNumber(), device.getUniqueDeviceId(),
Collections.emptyList()));
addDevicesToList(deviceList, device.getConnectedDevices());
}
return deviceList;
}
private static List getUsbDevices() {
// Maps to store information using node # as the key
Map nameMap = new HashMap<>();
Map vendorMap = new HashMap<>();
Map vendorIdMap = new HashMap<>();
Map productIdMap = new HashMap<>();
Map serialMap = new HashMap<>();
Map parentMap = new HashMap<>();
Map> hubMap = new HashMap<>();
// Enumerate all devices and build information maps. This will build the
// entire device tree; we will identify the controllers as the parents
// of the usbus entries and eventually only populate the returned
// results with those
List devices = ExecutingCommand.runNative("lshal");
if (devices.isEmpty()) {
return Collections.emptyList();
}
// For each item enumerated, store information in the maps
String key = "";
List usBuses = new ArrayList<>();
for (String line : devices) {
// udi = ... identifies start of a new tree
if (line.startsWith("udi =")) {
// Remove indent for key
key = ParseUtil.getSingleQuoteStringValue(line);
} else if (!key.isEmpty()) {
// We are currently processing for node identified by key. Save
// approrpriate variables to maps.
line = line.trim();
if (!line.isEmpty()) {
if (line.startsWith("freebsd.driver =")
&& "usbus".equals(ParseUtil.getSingleQuoteStringValue(line))) {
usBuses.add(key);
} else if (line.contains(".parent =")) {
String parent = ParseUtil.getSingleQuoteStringValue(line);
// If this is interface of parent, skip
if (key.replace(parent, "").startsWith("_if")) {
continue;
}
// Store parent for later usbus-skipping
parentMap.put(key, parent);
// Add this key to the parent's hubmap list
hubMap.computeIfAbsent(parent, x -> new ArrayList<>()).add(key);
} else if (line.contains(".product =")) {
nameMap.put(key, ParseUtil.getSingleQuoteStringValue(line));
} else if (line.contains(".vendor =")) {
vendorMap.put(key, ParseUtil.getSingleQuoteStringValue(line));
} else if (line.contains(".serial =")) {
String serial = ParseUtil.getSingleQuoteStringValue(line);
serialMap.put(key,
serial.startsWith("0x") ? ParseUtil.hexStringToString(serial.replace("0x", ""))
: serial);
} else if (line.contains(".vendor_id =")) {
vendorIdMap.put(key, String.format("%04x", ParseUtil.getFirstIntValue(line)));
} else if (line.contains(".product_id =")) {
productIdMap.put(key, String.format("%04x", ParseUtil.getFirstIntValue(line)));
}
}
}
}
// Build tree and return
List controllerDevices = new ArrayList<>();
for (String usbus : usBuses) {
// Skip the usbuses: make their parents the controllers and replace
// parents' children with the buses' children
String parent = parentMap.get(usbus);
hubMap.put(parent, hubMap.get(usbus));
controllerDevices.add(getDeviceAndChildren(parent, "0000", "0000", nameMap, vendorMap, vendorIdMap,
productIdMap, serialMap, hubMap));
}
return controllerDevices;
}
private static void addDevicesToList(List deviceList, List list) {
for (UsbDevice device : list) {
deviceList.add(device);
addDevicesToList(deviceList, device.getConnectedDevices());
}
}
/**
* Recursively creates FreeBsdUsbDevices by fetching information from maps to
* populate fields
*
* @param devPath
* The device node path.
* @param vid
* The default (parent) vendor ID
* @param pid
* The default (parent) product ID
* @param nameMap
* the map of names
* @param vendorMap
* the map of vendors
* @param vendorIdMap
* the map of vendorIds
* @param productIdMap
* the map of productIds
* @param serialMap
* the map of serial numbers
* @param hubMap
* the map of hubs
* @return A SolarisUsbDevice corresponding to this device
*/
private static FreeBsdUsbDevice getDeviceAndChildren(String devPath, String vid, String pid,
Map nameMap, Map vendorMap, Map vendorIdMap,
Map productIdMap, Map serialMap, Map> hubMap) {
String vendorId = vendorIdMap.getOrDefault(devPath, vid);
String productId = productIdMap.getOrDefault(devPath, pid);
List childPaths = hubMap.getOrDefault(devPath, new ArrayList<>());
List usbDevices = new ArrayList<>();
for (String path : childPaths) {
usbDevices.add(getDeviceAndChildren(path, vendorId, productId, nameMap, vendorMap, vendorIdMap,
productIdMap, serialMap, hubMap));
}
Collections.sort(usbDevices);
return new FreeBsdUsbDevice(nameMap.getOrDefault(devPath, vendorId + ":" + productId),
vendorMap.getOrDefault(devPath, ""), vendorId, productId, serialMap.getOrDefault(devPath, ""), devPath,
usbDevices);
}
}