Debug problem on CDC ACM example

RE: Debug problem on CDC ACM example

Karl Ylvisaker — Fri, 11 Dec 2020 11:30:38 GMT

Hello,

[quote user="LNwork"]

I get this error when I run the completely unmodified example. I downloaded the SDK and then using SES I flashed the nRF52840DK.

I want to clarify that the program works correctly. As I'm new to programming, I tried debugging despite the program working. It is by doing this that I encountered the problem I was telling you in previous messages. I hope my message is clear, sorry but I am using translator and it may not be clear.

[/quote]

Now I understand, thank you for clarifying this. I am happy to hear that the example is working correctly.
As I mentioned before it is absolutely possible that this particular issue is caused by the debugging itself - since the CPU is halted between debugging steps the communication might fail as a result. This could indeed be what is causing your issue.

Best regards,
Karl

RE: Debug problem on CDC ACM example

alexlöddeköpinge — Thu, 10 Dec 2020 14:23:53 GMT

[quote userid="87869" url="~/f/nordic-q-a/69182/debug-problem-on-cdc-acm-example/284351#284351"]Are you getting this error when you run the completely unmodified example, or have you made any changes ( like calling the write function periodically, like discussed in your other tickets )?[/quote]

I get this error when I run the completely unmodified example. I downloaded the SDK and then using SES I flashed the nRF52840DK.

Thanks again.

RE: Debug problem on CDC ACM example

Karl Ylvisaker — Thu, 10 Dec 2020 14:16:23 GMT

[quote user="LNwork"]ret = app_usbd_cdc_acm_write(&m_app_cdc_acm, m_tx_buffer, size);[/quote]

Thank you for clarifying.
With the returned error code and which function that returned it, we can start looking into what triggered it.
We start with looking at the API Reference documentation for the triggering app_usbd_cdc_acm_write function. We see here that this function is a higher-level function, which will return standard error codes as generated on the lower levels. We therefore look into the source code of the usbd_cdc_acm driver, to figure out why this error was generated - we find this file located at SDK_ROOT\components\libraries\usbd\class\cdc\acm.
We see that it in fact returns the error code of the app_usbd_ep_transfer function.
An exempt from the app_usbd_ep_tranfer_function API documentation reads:

NRFX_ERROR_BUSY

Selected endpoint is pending.

So, it seems the endpoint is pending.
Are you getting this error when you run the completely unmodified example, or have you made any changes ( like calling the write function periodically, like discussed in your other tickets )?
Could you tell me how to provoke this error, so that I may try to replicate it?

[quote user="LNwork"]I haven't changed anything in the example so I don't understand where the problem is. Is it a bug in the SDK?[/quote]

That is of course always a possibility, but it is not the most likely one.

Best regards,
Karl

RE: Debug problem on CDC ACM example

alexlöddeköpinge — Thu, 10 Dec 2020 11:02:58 GMT

[quote userid="87869" url="~/f/nordic-q-a/69182/debug-problem-on-cdc-acm-example/284291#284291"]Which function returned the error message passed to the APP_ERROR_CHECK at line 357?[/quote]

ret = app_usbd_cdc_acm_write(&m_app_cdc_acm, m_tx_buffer, size);

I haven't changed anything in the example so I don't understand where the problem is. Is it a bug in the SDK?

RE: Debug problem on CDC ACM example

Karl Ylvisaker — Thu, 10 Dec 2020 10:53:12 GMT

[quote user="LNwork"]Maybe you are referring to this error code?[/quote]

Yes, thank you, this is exactly the error code I am referring to.
To start looking into the error we also need to see which function that returned the NRF_ERROR_BUSY. The error message indicates that the error code was passed to an APP_ERROR_CHECK on line 357 of main.c
Which function returned the error message passed to the APP_ERROR_CHECK at line 357?

Best regards,
Karl

RE: Debug problem on CDC ACM example

alexlöddeköpinge — Thu, 10 Dec 2020 10:18:11 GMT

[quote userid="87869" url="~/f/nordic-q-a/69182/debug-problem-on-cdc-acm-example/284273#284273"]Defining DEBUG in the preprocessor defines will make a detailed error message be written to the log, which we may then use to identify the issue the application is encountering.[/quote]

<error> app: ERROR 17 [NRF_ERROR_BUSY] at C:\Users\blackp\Desktop\DeviceDownlo ad\nRF5SDK1702d674dde\nRF5_SDK_17.0.2_d674dde\examples\peripheral\usbd_cdc_acm\main.c:357

Maybe you are referring to this error code?

Thanks

RE: Debug problem on CDC ACM example

Karl Ylvisaker — Thu, 10 Dec 2020 10:12:43 GMT

[quote user="LNwork"]

The output is:

<error> app: Fatal error
<warning> app: System reset

[/quote]

Could you confirm for me which logger backend you are using, and that you have DEBUG defined in your preprocessor defines - like shown in the image I included in my first comment?

[quote user="LNwork"]Also adding the line as you advised me, when I press the button, frame_counter increases by a few units and then the system resets itself automatically. In other words, the program no longer works as it should.[/quote]

Yes, as I mentioned in my previous comment the default error handling done by APP_ERROR_CHECK when it receives an error code != NRF_CONNECT is to reset the device.
Defining DEBUG in the preprocessor defines will make a detailed error message be written to the log, which we may then use to identify the issue the application is encountering.

[quote user="LNwork"]I thank you infinitely for your availability and for your precious collaboration. Have a nice day.[/quote]

No problem at all, I am happy to help!

Looking forward to resolving this issue together.

Best regards,
Karl

RE: Debug problem on CDC ACM example

alexlöddeköpinge — Thu, 10 Dec 2020 08:32:10 GMT

[quote userid="87869" url="~/f/nordic-q-a/69182/debug-problem-on-cdc-acm-example/284147#284147"]Please let me know what the outputted error message says.[/quote]

The output is:

<error> app: Fatal error
<warning> app: System reset

Also adding the line as you advised me, when I press the button, frame_counter increases by a few units and then the system resets itself automatically. In other words, the program no longer works as it should. I thank you infinitely for your availability and for your precious collaboration. Have a nice day.

RE: Debug problem on CDC ACM example

Karl Ylvisaker — Wed, 09 Dec 2020 15:41:14 GMT

[quote user="LNwork"]

At line 67 there is a conditional statement. In the debug phase the condition is not verified and therefore in the debug it would seem that frame_counter is not incremented. However trying the program it results that frame_counter is incremented.

[/quote]

Ah, so it is. I understand. Could you go ahead and add a APP_ERROR_CHECK(ret) right after the line?
This should always be done when an error code is returned, in order to find out whether it was successful or not.
I am not certain why it was not added in the first place in the example, and will create an internal ticket to inquire about this, and ask that it is added in future versions.

If the error is != NRF_SUCCESS then the APP_ERROR_CHECK will print a more detailed error message to the log, before resetting the device ( default error handling ).

Please let me know what the outputted error message says.

[quote user="LNwork"]Sorry if I can't explain myself well but I'm not very familiar with English as I am Swedish.[/quote]

No worries, your English is fine for now and I will do my best to understand what you mean.

Best regards,
Karl

RE: Debug problem on CDC ACM example

alexlöddeköpinge — Wed, 09 Dec 2020 11:11:56 GMT

There is not an error messagge.

int main(void)
{
    ret_code_t ret;
    static const app_usbd_config_t usbd_config = {
        .ev_state_proc = usbd_user_ev_handler
    };

    ret = NRF_LOG_INIT(NULL);
    APP_ERROR_CHECK(ret);

    ret = nrf_drv_clock_init();
    APP_ERROR_CHECK(ret);
    
    nrf_drv_clock_lfclk_request(NULL);

    while(!nrf_drv_clock_lfclk_is_running())
    {
        /* Just waiting */
    }

    ret = app_timer_init();
    APP_ERROR_CHECK(ret);

    init_bsp();
#if NRF_CLI_ENABLED
    init_cli();
#endif

    app_usbd_serial_num_generate();

    ret = app_usbd_init(&usbd_config);
    APP_ERROR_CHECK(ret);
    NRF_LOG_INFO("USBD CDC ACM example started.");

    app_usbd_class_inst_t const * class_cdc_acm = app_usbd_cdc_acm_class_inst_get(&m_app_cdc_acm);
    ret = app_usbd_class_append(class_cdc_acm);
    APP_ERROR_CHECK(ret);

    if (USBD_POWER_DETECTION)
    {
        ret = app_usbd_power_events_enable();
        APP_ERROR_CHECK(ret);
    }
    else
    {
        NRF_LOG_INFO("No USB power detection enabled\r\nStarting USB now");

        app_usbd_enable();
        app_usbd_start();
    }

    while (true)
    {
        while (app_usbd_event_queue_process())
        {
            /* Nothing to do */
        }
        
        if(m_send_flag)
        {
            static int  frame_counter;

            size_t size = sprintf(m_tx_buffer, "Hello USB CDC FA demo: %u\r\n", frame_counter);

            ret = app_usbd_cdc_acm_write(&m_app_cdc_acm, m_tx_buffer, size);
            
            if (ret == NRF_SUCCESS)
            {
                ++frame_counter;
            }
        }
        
#if NRF_CLI_ENABLED
        nrf_cli_process(&m_cli_uart);
#endif

        UNUSED_RETURN_VALUE(NRF_LOG_PROCESS());
        /* Sleep CPU only if there was no interrupt since last loop processing */
        __WFE();
    }
}

/** @} */

Sorry if I can't explain myself well but I'm not very familiar with English as I am Swedish.

RE: Debug problem on CDC ACM example

Karl Ylvisaker — Wed, 09 Dec 2020 11:06:24 GMT

[quote user="LNwork"]Yes, now I see outputs on Termite. The problem is that there is not any error message (I see only info as the application initializing). The program works fine as ret=NRF_SUCCESS [/quote]

Great!

What is the error message generated when you are using the debugger?

Please be advised that when you are using the debugger, and halting the program you are actually halting the CPU. This might cause certain timing-critical processes to fail ( such as the SoftDevice BLE communication ), as a result of the debugging.

Best regards,
Karl

RE: Debug problem on CDC ACM example

alexlöddeköpinge — Wed, 09 Dec 2020 10:56:10 GMT

[quote userid="87869" url="~/f/nordic-q-a/69182/debug-problem-on-cdc-acm-example/283728#283728"]If you open a serial terminal, like PuTTY or Termite, and open the port to which the device is connected, then you should see outputs by the device when it is running. It will print some messages as the application initializing, and then again if it encounters some error or receives data through the USB.[/quote]

Yes, now I see outputs on Termite. The problem is that there is not any error message (I see only info as the application initializing). The program works fine as ret=NRF_SUCCESS

The only problem is during debugging, when I debug seems that ret is not NRF_SUCCESS.

It's like there's a difference beetween debug and when the program is flashed in the nRF52840.

Thanks

RE: Debug problem on CDC ACM example

Karl Ylvisaker — Tue, 08 Dec 2020 09:08:18 GMT

Hello,

[quote user="LNwork"]Yes, I have DEBUG defined in my preprocessor defines.[/quote]

Great!

[quote user="LNwork"]How can I view the logger output?[/quote]

The USB CDC ACM example uses the UART logger backend by default.
Are you familiar with using serial terminals?
If you open a serial terminal, like PuTTY or Termite, and open the port to which the device is connected, then you should see outputs by the device when it is running. It will print some messages as the application initializing, and then again if it encounters some error or receives data through the USB.
Please let me know if you are not able to see the messages outputted by the device to the logger.

[quote user="LNwork"]Sorry but I'm new at programming with SES[/quote]

Welcome! No need to apologize, we've all been new to it at some point! :)

Please do not hesitate to ask if you should encounter any issues or questions!

Best regards,
Karl

RE: Debug problem on CDC ACM example

alexlöddeköpinge — Mon, 07 Dec 2020 17:27:16 GMT

Yes, I have DEBUG defined in my preprocessor defines.

How can I view the logger output?

Sorry but I'm new at programming with SES

RE: Debug problem on CDC ACM example

Karl Ylvisaker — Mon, 07 Dec 2020 16:19:09 GMT

Hello,

[quote user=""]I'm debbuging CDC ACM example (I haven't changed it) but when I debug: ret = app_usbd_cdc_acm_write(&m_app_cdc_acm, m_tx_buffer, size) I have that ret is not NRF_SUCCESS,[/quote]

Could you make sure that you have DEBUG defined in your preprocessor defines, like shown in the included image?
This will make a more complete error message be printed to your logger output when an APP_ERROR_CHECK is passed a non-NRF_SUCCESS argument.

Please do this, and let me know what is outputted to your log when the error occurs.

Best regards,
Karl