Mark new stuff experimental for now

Author: pgrawehr

src/System.Device.Gpio.Tests/SysFsDriverTests.cs

@@ -6,6 +6,7 @@
 using Xunit;
 using Xunit.Abstractions;
 
+#pragma warning disable SDGPIO0001
 namespace System.Device.Gpio.Tests;
 
 [Trait("requirement", "root")]
@@ -47,7 +48,7 @@ public void CheckAllChipsCanBeConstructed()
 
         foreach (var chip in chips)
         {
-            var driver = new SysFsDriver(chip.Id);
+            var driver = new SysFsDriver(chip);
             var ctrl = new GpioController(driver);
             Assert.NotNull(ctrl);
             var driverInfo = driver.GetChipInfo();

src/System.Device.Gpio/System/Device/Gpio/Drivers/LibGpiodDriver.cs

@@ -8,6 +8,8 @@
 using System.Device.Gpio.Libgpiod.V1;
 using System.Diagnostics;
 using System.Linq;
+using System.Diagnostics.CodeAnalysis;
+
 using LibgpiodV1 = Interop.LibgpiodV1;
 
 namespace System.Device.Gpio.Drivers;
@@ -93,10 +95,21 @@ public LibGpiodDriver(int gpioChip = 0)
         }
     }
 
+    /// <summary>
+    /// Construct an instance of this driver with the provided chip.
+    /// </summary>
+    /// <param name="chip">The chip to use. Should be one of the elements returned by <see cref="GetAvailableChips"/></param>
+    [Experimental(DiagnosticIds.SDGPIO0001, UrlFormat = DiagnosticIds.UrlFormat)]
+    public LibGpiodDriver(GpioChipInfo chip)
+        : this(chip.Id)
+    {
+    }
+
     /// <summary>
     /// Returns the set of available chips for this driver
     /// </summary>
     /// <returns>A list of <see cref="GpioChipInfo"/> instances</returns>
+    [Experimental(DiagnosticIds.SDGPIO0001, UrlFormat = DiagnosticIds.UrlFormat)]
     public static IList<GpioChipInfo> GetAvailableChips()
     {
         List<GpioChipInfo> result = new List<GpioChipInfo>();
@@ -448,6 +461,7 @@ public override ComponentInformation QueryComponentInformation()
     }
 
     /// <inheritdoc />
+    [Experimental(DiagnosticIds.SDGPIO0001, UrlFormat = DiagnosticIds.UrlFormat)]
     public override GpioChipInfo GetChipInfo()
     {
         return GetAvailableChips().First(x => x.Id == _chipNumber);

src/System.Device.Gpio/System/Device/Gpio/Drivers/LibGpiodV2Driver.cs

@@ -36,11 +36,20 @@ public sealed class LibGpiodV2Driver : UnixDriver
     /// Creates a driver instance for the specified GPIO chip.
     /// </summary>
     /// <param name="chipNumber">Chip number to use.</param>
-    /// <param name="waitEdgeEventsTimeout">Timeout to wait for edge events. Primarily used for testing.</param>
-    public LibGpiodV2Driver(int chipNumber, TimeSpan? waitEdgeEventsTimeout = null)
+    public LibGpiodV2Driver(int chipNumber)
     {
         _chip = LibGpiodProxyFactory.CreateChip(chipNumber);
-        _eventObserver = new LibGpiodV2EventObserver { WaitEdgeEventsTimeout = waitEdgeEventsTimeout ?? TimeSpan.FromMilliseconds(100) };
+        _eventObserver = new LibGpiodV2EventObserver { WaitEdgeEventsTimeout = TimeSpan.FromMilliseconds(100) };
+    }
+
+    /// <summary>
+    /// Construct an instance of this driver with the provided chip.
+    /// </summary>
+    /// <param name="chip">The chip to use. Should be one of the elements returned by <see cref="GetAvailableChips"/></param>
+    [Experimental(DiagnosticIds.SDGPIO0001, UrlFormat = DiagnosticIds.UrlFormat)]
+    public LibGpiodV2Driver(GpioChipInfo chip)
+        : this(chip.Id)
+    {
     }
 
     /// <inheritdoc/>

src/System.Device.Gpio/System/Device/Gpio/Drivers/SysFsDriver.cs

@@ -2,6 +2,7 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 
 using System.Collections.Generic;
+using System.Diagnostics.CodeAnalysis;
 using System.Globalization;
 using System.IO;
 using System.Linq;
@@ -86,18 +87,19 @@ public SysFsDriver()
     /// <summary>
     /// Creates a SysFsDriver instance for the provided chip number
     /// </summary>
-    /// <param name="chip">The chip number to select (use <see cref="GetAvailableChips"/> to query the list of available values)</param>
+    /// <param name="chip">The chip to select (use <see cref="GetAvailableChips"/> to query the list of available values)</param>
     /// <exception cref="PlatformNotSupportedException"></exception>
-    public SysFsDriver(int chip)
+    [Experimental(DiagnosticIds.SDGPIO0001, UrlFormat = DiagnosticIds.UrlFormat)]
+    public SysFsDriver(GpioChipInfo chip)
     {
         if (Environment.OSVersion.Platform != PlatformID.Unix)
         {
             throw new PlatformNotSupportedException($"{GetType().Name} is only supported on Linux/Unix.");
         }
 
         _isDisposed = false;
-        _chipNumber = chip;
-        _pinOffset = ReadOffset(chip);
+        _chipNumber = chip.Id;
+        _pinOffset = ReadOffset(chip.Id);
     }
 
     /// <summary>
@@ -120,6 +122,7 @@ internal TimeSpan StatusUpdateSleepTime
     /// This can be used to determine the correct gpio chip for constructor calls to <see cref="LibGpiodDriver"/>
     /// </summary>
     /// <returns>A list of chips detected</returns>
+    [Experimental(DiagnosticIds.SDGPIO0001, UrlFormat = DiagnosticIds.UrlFormat)]
     public static IList<GpioChipInfo> GetAvailableChips()
     {
         string[] fileNames = Directory.GetFileSystemEntries(GpioBasePath, $"{GpioChip}*", SearchOption.TopDirectoryOnly);
@@ -167,6 +170,7 @@ public static IList<GpioChipInfo> GetAvailableChips()
         return list;
     }
 
+    [Experimental(DiagnosticIds.SDGPIO0001, UrlFormat = DiagnosticIds.UrlFormat)]
     private static GpioChipInfo GetChipInfoForName(string name)
     {
         int idx = name.IndexOf(GpioChip, StringComparison.Ordinal);
@@ -701,6 +705,7 @@ protected override void Dispose(bool disposing)
     }
 
     /// <inheritdoc />
+    [Experimental(DiagnosticIds.SDGPIO0001, UrlFormat = DiagnosticIds.UrlFormat)]
     public override GpioChipInfo GetChipInfo()
     {
         return GetAvailableChips().First(x => x.Id == _chipNumber);

src/System.Device.Gpio/System/Device/Gpio/GpioChipInfo.cs

@@ -1,11 +1,14 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
+using System.Diagnostics.CodeAnalysis;
+
 namespace System.Device.Gpio
 {
     /// <summary>
     /// Provides information about a GPIO chip
     /// </summary>
+    [Experimental(DiagnosticIds.SDGPIO0001, UrlFormat = DiagnosticIds.UrlFormat)]
     public record GpioChipInfo(int Id, string Name, string Label, int NumLines)
     {
         /// <summary>

src/System.Device.Gpio/System/Device/Gpio/GpioController.cs

@@ -534,14 +534,15 @@ private static GpioDriver GetBestDriverForBoardOnLinux()
                 // For now, for Raspberry Pi 5, we'll use the LibGpiodDriver.
                 // We need to create a new driver for the Raspberry Pi 5,
                 // because the Raspberry Pi 5 uses an entirely different GPIO controller (RP1)
+#pragma warning disable SDGPIO0001
                 var chips = LibGpiodDriver.GetAvailableChips();
                 // The RP1 chip reports 54 lines
                 GpioChipInfo? selectedChip = chips.FirstOrDefault(x => x.NumLines == 54);
                 if (selectedChip is null)
                 {
                     throw new NotSupportedException("Couldn't find the default GPIO chip. You might need to create the LibGpiodDriver explicitly");
                 }
-
+#pragma warning restore SDGPIO0001
                 return new LibGpiodDriver(selectedChip.Id);
 
             default:

src/System.Device.Gpio/System/Device/Gpio/GpioDriver.cs

@@ -1,6 +1,7 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
+using System.Diagnostics.CodeAnalysis;
 using System.Threading;
 using System.Threading.Tasks;
 
@@ -176,6 +177,7 @@ public virtual ComponentInformation QueryComponentInformation()
     /// </summary>
     /// <returns>An instance of the <see cref="GpioChipInfo"/> record</returns>
     /// <exception cref="NotSupportedException">The current driver does not support this data</exception>
+    [Experimental(DiagnosticIds.SDGPIO0001, UrlFormat = DiagnosticIds.UrlFormat)]
     public virtual GpioChipInfo GetChipInfo()
     {
         throw new NotSupportedException();