Merge pull request #131 from K-Society/experimental

Experimental

README.md

@@ -29,7 +29,7 @@ Please make sure you have updated the firmware of your ST-LINK V2 / V3, you can
 The STM32 CubeProgrammer_API is a C-library, created by ST for ST-Link access to micro-controllers 
 for the purpose of flash downloads or general memory access. 
 The ST-Link drivers is required, and can be downloaded from st.com and installed [(STSW-LINK009)](https://www.st.com/en/development-tools/stsw-link009.html).
-This has been tested on Windows 10, you don't need to install STM32CubeProgrammer.
+This has been tested on Windows 10 and Windows 11, you don't need to install STM32CubeProgrammer.
 
 ### KSociety.SharpCubeProgrammer
 STM32CubeProgrammer_API C# wrapper, the first wrapper for C#. Any suggestions are welcome.
@@ -260,5 +260,4 @@ The project is under Microsoft Reciprocal License [(MS-RL)](http://www.opensourc
 
 List of technologies, frameworks and libraries used for implementation:
 
-- [Microsoft.Bcl.AsyncInterfaces](https://www.nuget.org/packages/Microsoft.Bcl.AsyncInterfaces) for .NET Standard 2.0 only.
 - [Microsoft.Extensions.Logging.Abstractions](https://www.nuget.org/packages/Microsoft.Extensions.Logging.Abstractions)

docs/KSociety.SharpCubeProgrammer/README.md

@@ -25,7 +25,7 @@ Please make sure you have updated the firmware of your ST-LINK V2 / V3, you can
 The STM32 CubeProgrammer_API is a C-library, created by ST for ST-Link access to micro-controllers 
 for the purpose of flash downloads or general memory access. 
 The ST-Link drivers is required, and can be downloaded from st.com and installed [(STSW-LINK009)](https://www.st.com/en/development-tools/stsw-link009.html).
-This has been tested on Windows 10, you don't need to install STM32CubeProgrammer.
+This has been tested on Windows 10 and Windows 11, you don't need to install STM32CubeProgrammer.
 
 ### KSociety.SharpCubeProgrammer
 STM32CubeProgrammer_API C# wrapper, the first wrapper for C#. Any suggestions are welcome.
@@ -255,5 +255,4 @@ The project is under Microsoft Reciprocal License [(MS-RL)](http://www.opensourc
 
 List of technologies, frameworks and libraries used for implementation:
 
-- [Microsoft.Bcl.AsyncInterfaces](https://www.nuget.org/packages/Microsoft.Bcl.AsyncInterfaces) for .NET Standard 2.0 only.
 - [Microsoft.Extensions.Logging.Abstractions](https://www.nuget.org/packages/Microsoft.Extensions.Logging.Abstractions)

src/01/KSociety.SharpCubeProgrammer/CubeProgrammerApi.cs

@@ -4,18 +4,20 @@ namespace SharpCubeProgrammer
 {
     using System;
     using System.Collections.Generic;
+    using System.Diagnostics.CodeAnalysis;
     using System.Globalization;
     using System.IO;
     using System.Runtime.InteropServices;
+    using System.Threading;
+    using System.Threading.Tasks;
     using DeviceDataStructure;
     using Enum;
     using Interface;
     using Microsoft.Extensions.Logging;
     using Microsoft.Extensions.Logging.Abstractions;
     using Struct;
-    using Util;
 
-    public class CubeProgrammerApi : Disposable, ICubeProgrammerApi
+    public class CubeProgrammerApi : ICubeProgrammerApi
     {
         /// <summary>
         /// Synchronization object to protect loading the native library and its functions. This field is read-only.
@@ -25,6 +27,9 @@ public class CubeProgrammerApi : Disposable, ICubeProgrammerApi
         private Native.SafeLibraryHandle _handle;
         private readonly ILogger<CubeProgrammerApi> _logger;
 
+        private const int DisposedFlag = 1;
+        private int _isDisposed;
+
         #region [Constructor]
 
         public CubeProgrammerApi(ILogger<CubeProgrammerApi> logger = default)
@@ -1517,8 +1522,27 @@ private CubeProgrammerError CheckResult(int result)
 
         #region [Dispose]
 
-        /// <inheritdoc/>
-        protected override void Dispose(bool disposing)
+        /// <summary>
+        /// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
+        /// </summary>
+        [SuppressMessage("Microsoft.Design", "CA1063:ImplementIDisposableCorrectly", Justification = "Dispose is implemented correctly, FxCop just doesn't see it.")]
+        public void Dispose()
+        {
+            var wasDisposed = Interlocked.Exchange(ref this._isDisposed, DisposedFlag);
+            if (wasDisposed == DisposedFlag)
+            {
+                return;
+            }
+
+            this.Dispose(true);
+            GC.SuppressFinalize(this);
+        }
+
+        /// <summary>
+        /// Releases unmanaged and - optionally - managed resources.
+        /// </summary>
+        /// <param name="disposing"><c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param>
+        protected void Dispose(bool disposing)
         {
             if (disposing)
             {
@@ -1528,8 +1552,51 @@ protected override void Dispose(bool disposing)
             // Free any unmanaged objects here.
             this._handle?.Dispose();
             this._handle = null;
+        }
+
+        /// <summary>
+        /// Gets a value indicating whether the current instance has been disposed.
+        /// </summary>
+        protected bool IsDisposed
+        {
+            get
+            {
+                Interlocked.MemoryBarrier();
+                return this._isDisposed == DisposedFlag;
+            }
+        }
+
+        /// <inheritdoc/>
+        [SuppressMessage(
+            "Usage",
+            "CA1816:Dispose methods should call SuppressFinalize",
+            Justification = "DisposeAsync should also call SuppressFinalize (see various .NET internal implementations).")]
+        public ValueTask DisposeAsync()
+        {
+            // Still need to check if we've already disposed; can't do both.
+            var wasDisposed = Interlocked.Exchange(ref this._isDisposed, DisposedFlag);
+            if (wasDisposed != DisposedFlag)
+            {
+                GC.SuppressFinalize(this);
+
+                // Always true, but means we get the similar syntax as Dispose,
+                // and separates the two overloads.
+                return this.DisposeAsync(true);
+            }
+
+            return default;
+        }
+
+        /// <summary>
+        ///  Releases unmanaged and - optionally - managed resources, asynchronously.
+        /// </summary>
+        /// <param name="disposing"><c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param>
+        protected ValueTask DisposeAsync(bool disposing)
+        {
+            // Default implementation does a synchronous dispose.
+            this.Dispose(disposing);
 
-            base.Dispose(disposing);
+            return default;
         }
 
         #endregion

src/01/KSociety.SharpCubeProgrammer/KSociety.SharpCubeProgrammer.csproj

@@ -59,7 +59,6 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.Bcl.AsyncInterfaces" Version="8.0.0" Condition="'$(TargetFramework)' == 'netstandard2.0'" />
     <PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="8.0.0" />
     <PackageReference Include="Microsoft.SourceLink.GitHub" Version="8.0.0">
       <PrivateAssets>all</PrivateAssets>

src/Directory.csproj.props

@@ -3,7 +3,7 @@
 
 <Project ToolsVersion="Current" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
   <PropertyGroup>
-	<TargetFrameworks>netstandard2.0;netstandard2.1</TargetFrameworks>
+	<TargetFrameworks>netstandard2.0</TargetFrameworks>
 
 	<AssemblyOriginatorKeyFile>$([System.IO.Path]::GetFullPath($(MSBuildThisFileDirectory)ksociety.snk))</AssemblyOriginatorKeyFile>
     <SignAssembly>true</SignAssembly>