AndroidDebugBridge/AndroidDebugBridgeTransport.USB.cs

/*
* MIT License
* 
* Copyright (c) 2024 The DuoWOA authors
* 
* 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.
*/
using MadWizard.WinUSBNet;
using System;
using System.Diagnostics;
using System.Threading;

namespace AndroidDebugBridge
{
    public partial class AndroidDebugBridgeTransport
    {
        private readonly USBDevice USBDevice = null;
        private readonly USBPipe InputPipe = null;
        private readonly USBPipe OutputPipe = null;

        private AndroidDebugBridgeMessage ReadMessage(bool VerifyCrc = true)
        {
            try
            {
                byte[] IncomingMessage = ReadFromUsb(24);
                (AndroidDebugBridgeCommands CommandIdentifier, uint FirstArgument, uint SecondArgument, uint CommandPayloadLength, uint CommandPayloadCrc) = AndroidDebugBridgeMessaging.ParseCommandPacket(IncomingMessage);

                if (CommandPayloadLength > 0)
                {
                    byte[] Payload = ReadFromUsb(CommandPayloadLength);

                    if (VerifyCrc)
                    {
                        AndroidDebugBridgeMessaging.VerifyAdbCrc(Payload, CommandPayloadCrc);
                    }

                    return new AndroidDebugBridgeMessage(CommandIdentifier, FirstArgument, SecondArgument, Payload);
                }

                return new AndroidDebugBridgeMessage(CommandIdentifier, FirstArgument, SecondArgument);
            }
            catch (Exception ex)
            {
                throw new AggregateException("Failed to read message!", ex);
            }
        }

        private void ReadMessageAsync(Action<AndroidDebugBridgeMessage> asyncCallback, Action<Exception> exceptionAsyncCallback, bool VerifyCrc = true)
        {
            byte[] IncomingMessage = new byte[24];
            ReadFromUsbAsync(IncomingMessage, (asyncReadCallback) =>
            {
                try
                {
                    (AndroidDebugBridgeCommands CommandIdentifier, uint FirstArgument, uint SecondArgument, uint CommandPayloadLength, uint CommandPayloadCrc) = AndroidDebugBridgeMessaging.ParseCommandPacket(IncomingMessage);

                    if (CommandPayloadLength > 0)
                    {
                        byte[] Payload = new byte[CommandPayloadLength];
                        ReadFromUsbAsync(Payload, (_) =>
                        {
                            if (VerifyCrc)
                            {
                                AndroidDebugBridgeMessaging.VerifyAdbCrc(Payload, CommandPayloadCrc);
                            }

                            asyncCallback.Invoke(new AndroidDebugBridgeMessage(CommandIdentifier, FirstArgument, SecondArgument, Payload));
                        }, exceptionAsyncCallback, asyncReadCallback.AsyncState);
                    }
                    else
                    {
                        asyncCallback.Invoke(new AndroidDebugBridgeMessage(CommandIdentifier, FirstArgument, SecondArgument));
                    }
                }
                catch (Exception ex)
                {
                    exceptionAsyncCallback(ex);
                }
            }, exceptionAsyncCallback);
        }

        private byte[] ReadFromUsb(uint size)
        {
            byte[] buffer = new byte[size];
            int attempts = 0;
            while (true)
            {
                try
                {
                    _ = InputPipe.Read(buffer);
                    break;
                }
                catch (Exception ex)
                {
                    attempts++;
                    if (attempts > 10)
                    {
                        throw new AggregateException("Failed to read from USB device!", ex);
                    }
                    Thread.Sleep(100);
                    Debug.WriteLine("Failed to read from input pipe, trying again. Attempt=" + attempts);
                }
            }

            return buffer;
        }

        private void ReadFromUsbAsync(byte[] buffer, AsyncCallback asyncCallback, Action<Exception> exceptionAsyncCallback, object? stateObject = null)
        {
            try
            {
                InputPipe.BeginRead(buffer, 0, buffer.Length, (asyncWriteState) =>
                {
                    try
                    {
                        InputPipe.EndRead(asyncWriteState);
                        asyncCallback(asyncWriteState);
                    }
                    catch (Exception ex)
                    {
                        exceptionAsyncCallback(ex);
                    }
                }, stateObject);
            }
            catch (Exception ex)
            {
                exceptionAsyncCallback(ex);
            }
        }

        internal void SendMessage(AndroidDebugBridgeMessage outgoingMessage)
        {
            //Debug.WriteLine($"> new AndroidDebugBridgeMessage(AndroidDebugBridgeCommands.{outgoingMessage.CommandIdentifier}, 0x{outgoingMessage.FirstArgument:X8}, 0x{outgoingMessage.FirstArgument:X8}, );");

            byte[] OutgoingMessage = AndroidDebugBridgeMessaging.GetCommandPacket(outgoingMessage.CommandIdentifier, outgoingMessage.FirstArgument, outgoingMessage.SecondArgument, outgoingMessage.Payload);
            WriteToUsb(OutgoingMessage);

            if (outgoingMessage.Payload != null)
            {
                WriteToUsb(outgoingMessage.Payload);
            }
        }

        private void SendMessageAsync(AndroidDebugBridgeMessage androidDebugBridgeMessage, Action? asyncCallback = null, Action<Exception> exceptionAsyncCallback = null)
        {
            byte[] OutgoingMessage = AndroidDebugBridgeMessaging.GetCommandPacket(androidDebugBridgeMessage.CommandIdentifier, androidDebugBridgeMessage.FirstArgument, androidDebugBridgeMessage.SecondArgument, androidDebugBridgeMessage.Payload);
            WriteToUsbAsync(OutgoingMessage, (asyncWriteObject) =>
            {
                if (androidDebugBridgeMessage.Payload != null)
                {
                    WriteToUsbAsync(androidDebugBridgeMessage.Payload, (_) => asyncCallback?.Invoke(), exceptionAsyncCallback, asyncWriteObject.AsyncState);
                }
            }, exceptionAsyncCallback);
        }

        private void WriteToUsb(byte[] buffer)
        {
            int attempts = 0;
            while (true)
            {
                try
                {
                    OutputPipe.Write(buffer);
                    break;
                }
                catch (Exception ex)
                {
                    attempts++;
                    if (attempts > 10)
                    {
                        throw new AggregateException("Failed to write to USB device!", ex);
                    }
                    Thread.Sleep(100);
                    Debug.WriteLine("Failed to write to output pipe, trying again. Attempt=" + attempts);
                }
            }
        }

        private void WriteToUsbAsync(byte[] buffer, AsyncCallback asyncCallback, Action<Exception> exceptionAsyncCallback, object? stateObject = null)
        {
            OutputPipe.BeginWrite(buffer, 0, buffer.Length, (asyncWriteState) =>
            {
                try
                {
                    OutputPipe.EndWrite(asyncWriteState);
                    asyncCallback(asyncWriteState);
                }
                catch (Exception ex)
                {
                    exceptionAsyncCallback(ex);
                }
            }, stateObject);
        }
    }
}