SetDisplayCallbacks

[maniglia]

The SetDisplayCallbacks function is used in Programmer.dll (dllmain) and disable the functionality of logging any message generated by the CubeProgrammer_API.dll library to maximize performance.

[mihaisvcc]

Hello maniglia,

thanks for the quick reply. In my opinion the SetDisplayCallbacks is useful when debug, normally is not needed.
It helped me to see that the CubeProgrammerAPI.dll is working as expected over the USB and I was able to see were it got stuck when I've made a mistake. It seems to decrease the CubeProgrammerAPI.dll speed when is used. I have tested the 32 bit variant without calling this function and it worked. The API documentation and the c++ examples are recommending to call this first along with the much critical SetLoadersPath. In your Programmer.dll SetDisplayCallbacks is called in dllmain.cpp at the DLL call.
Kind Regards,

[maniglia]

Well, then it will be time to introduce the possibility of enabling dubug mode.
I agree that it can be useful when you need to debug.

[maniglia]

There is a new version, the 0.1.70.
I removed all references of the SetDisplayCallbacks function from main in Programmer.dll, now you can call the SetDisplayCallbacks
method.
I did some testing using the following example:

var displayCallBacks = new DisplayCallBacks
{
    InitProgressBar = null, 
    LogMessage = ReceiveMessage,
    LoadBar = null, 
};

CubeProgrammerApi.SetDisplayCallbacks(ref displayCallBacks);

CubeProgrammerApi.SetVerbosityLevel(CubeProgrammerVerbosityLevel.CubeprogrammerVerLevelDebug);

I'm having problems when I try to set the InitProgressBar and LoadBar, I think it is necessary to test this feature thoroughly.
Any feedback is welcome.

[mihaisvcc]

Hello maniglia,

i share here how i use the SetDisplayCallbacks in the following way:

SetDisplayCallbacks(InitProgressBar, ReceiveMessage, ProgressBarUpdate);

  private void ReceiveMessage(int messgaeType, string message)
        {
            //only if I want to see message from the dll, more messages are coming when verbosity level is at 3
        
        }
        private void InitProgressBar()
        {

        }

        private void ProgressBarUpdate(int currentProgress, int total)
        {
            float current;
            if (total > 0)
            {
                //can use current variable to set a progress bar, I have noticed that currentProgress is advancing only by write or download 
                //operation, erase operation does not produce advance
                current = (float)((currentProgress * 100) / total);
                
            }
        }

My delegates

public delegate void LogMessageReceived(int messageType, [MarshalAs(UnmanagedType.LPWStr)] string message);
      public delegate void InitProgressBar();
      public delegate void ProgressBarUpdateReceived(int currentProgress, int total);

public struct DisplayCallbacks
      {
          public InitProgressBar initProgressBar;
          public LogMessageReceived logMessage;
          public ProgressBarUpdateReceived loadBar;
      }

public static void SetDisplayCallbacks(InitProgressBar initProgressBar, LogMessageReceived messageReceived, ProgressBarUpdateReceived progressBarUpdate)
{
DisplayCallbacks callbacksHandle;

    callbacksHandle.initProgressBar = initProgressBar;
    callbacksHandle.logMessage = messageReceived;
    callbacksHandle.loadBar = progressBarUpdate;

    SetDisplayCallbacks(ref callbacksHandle); //call to dll import
}

It works good under x64 under x32 the dll import crashes ...i don't know why ?

[maniglia]

It's strange I also tested 32 bit without problems, can you share a project with this problem?

[maniglia]

Hello @mihaisvcc,
I'm not sure I solved the problem, I think I forgot some decorators on the delegates in DisplayCallBacks structure.
This is the content of the new version of the DisplayCallBacks.cs file:

namespace KSociety.SharpCubeProgrammer.Struct
{
    using System.Runtime.InteropServices;

    [UnmanagedFunctionPointer(CallingConvention.Cdecl, SetLastError = true)]
    public delegate void InitProgressBar();

    [UnmanagedFunctionPointer(CallingConvention.Cdecl, SetLastError = true)]
    public delegate void LogMessageReceived(int messageType, [MarshalAs(UnmanagedType.LPWStr)] string message);

    [UnmanagedFunctionPointer(CallingConvention.Cdecl, SetLastError = true)]
    public delegate void ProgressBarUpdateReceived(int currentProgress, int total);

    /// <summary>
    /// Functions must be implemented to personalize the display of messages.
    /// </summary>
    [StructLayout(LayoutKind.Sequential, CharSet = CharSet.Ansi)]
    public struct DisplayCallBacks
    {
        public InitProgressBar? InitProgressBar;
        public LogMessageReceived? LogMessage;
        public ProgressBarUpdateReceived? LoadBar;
    }
}

Please let me know if you can test this code snippet.
Regards

[mihaisvcc]

Hello @maniglia

Thank you for your answer and for the code snippet.
I have tested this...the problem seems to remain.
I got an access violation for the x86 driver if I compile as 32bit.
I have attached a test project made in VS2022 to see if you can reproduce the problem.
The test project is trimmed to a very basic level.
Now because the project file was very large, please copy inside the bin\debug and release folder the st and the
dll\x86
\x64
st\Programmer\FlashLoader
\ExternalLoader

Regards,

CubeProgrammerAPIDirectTest.zip

System.AccessViolationException
HResult=0x80004003
Message=Attempted to read or write protected memory. This is often an indication that other memory is corrupt.
Source=
StackTrace:

[maniglia]

Hello @mihaisvcc,
to fix the exception, please edit the CubeProgrammerApi.cs file, for Native.SetDisplayCallbacks remove ref keyword:
Before:

[DllImport(Dll64, CallingConvention = CallingConvention.Cdecl, EntryPoint = "setDisplayCallbacks")]
internal static extern void SetDisplayCallbacks64(ref DisplayCallbacks callbacks);
[DllImport(Dll32, CallingConvention = CallingConvention.Cdecl, EntryPoint = "setDisplayCallbacks")]
internal static extern void SetDisplayCallbacks32(ref DisplayCallbacks callbacks);
internal static void SetDisplayCallbacks(ref DisplayCallbacks callbacks)
{
    if (Environment.Is64BitProcess)
    {
        SetDisplayCallbacks64(ref callbacks);
    }
    else
    {
        SetDisplayCallbacks32(ref callbacks);
    }
}

After:

[DllImport(Dll64, CallingConvention = CallingConvention.Cdecl, EntryPoint = "setDisplayCallbacks")]
internal static extern void SetDisplayCallbacks64(DisplayCallbacks callbacks);
[DllImport(Dll32, CallingConvention = CallingConvention.Cdecl, EntryPoint = "setDisplayCallbacks")]
internal static extern void SetDisplayCallbacks32(DisplayCallbacks callbacks);
internal static void SetDisplayCallbacks(DisplayCallbacks callbacks)
{
    if (Environment.Is64BitProcess)
    {
        SetDisplayCallbacks64(callbacks);
    }
    else
    {
       SetDisplayCallbacks32(callbacks);
    }
}

Consequently the SetDisplayCallbacks method also changes:

public static void SetDisplayCallbacks(InitProgressBar initProgressBar, LogMessageReceived messageReceived, ProgressBarUpdateReceived progressBarUpdate)
{
    Native.DisplayCallbacks callbacksHandle;

    callbacksHandle.initProgressBar = initProgressBar;
    callbacksHandle.logMessage = messageReceived;
    callbacksHandle.loadBar = progressBarUpdate;

    //if (Environment.Is64BitProcess)
    //{
        Native.SetDisplayCallbacks(callbacksHandle); // ?? x86 crash
   // }
}

Regards

[mihaisvcc]

Hello @maniglia

Thank you very much for update. Unfortunately this does not seem to solve my problem.
I sitll got the memory corrupt error when I try to call the DisplayCallbacks x86 bit dll when my app si compiled as 32bit.
I have made a test project, very simple in VS2022. Please test this when you have time and tell me what you think.
In the test project I have deleted the x64 dll's in order to keep it small size.

Kind regards,
CubeProgrammerAPIDirectTest.zip

[maniglia]

It works for me with the modified file, you sent me the same project again.

[mihaisvcc]

Hello @maniglia

Thank you for the correction tip !!, It works now for me also. Sorry for the double post...after hitting the comment button the content was first displayed only after a couple of minutes, then I made the mistake to post it again.