summaryrefslogtreecommitdiff
path: root/common/usbx_device_classes/src/ux_device_class_dfu_tasks_run.c
blob: be100c6fed05e37106294f589c6aeb5e4e96ba60 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
/***************************************************************************
 * Copyright (c) 2024 Microsoft Corporation
 * Copyright (c) 2026-present Eclipse ThreadX contributors
 *
 * This program and the accompanying materials are made available under the
 * terms of the MIT License which is available at
 * https://opensource.org/licenses/MIT.
 *
 * SPDX-License-Identifier: MIT
 **************************************************************************/

/**************************************************************************/
/**************************************************************************/
/**                                                                       */
/** USBX Component                                                        */
/**                                                                       */
/**   Device dfu Class                                                    */
/**                                                                       */
/**************************************************************************/
/**************************************************************************/

#define UX_SOURCE_CODE


/* Include necessary system files.  */

#include "ux_api.h"
#include "ux_device_class_dfu.h"
#include "ux_device_stack.h"


#if defined(UX_DEVICE_STANDALONE)
/**************************************************************************/
/*                                                                        */
/*  FUNCTION                                               RELEASE        */
/*                                                                        */
/*    _ux_device_class_dfu_tasks_run                      PORTABLE C      */
/*                                                           6.1.10       */
/*  AUTHOR                                                                */
/*                                                                        */
/*    Chaoqiong Xiao, Microsoft Corporation                               */
/*                                                                        */
/*  DESCRIPTION                                                           */
/*                                                                        */
/*    This function is the background task of the dfu class. It waits for */
/*    the dfu command to signal a DFU_DETACH stage and either force a     */
/*    disconnect from the device or wait for the host to detach.          */
/*                                                                        */
/*  INPUT                                                                 */
/*                                                                        */
/*    class_instance                              DFU class instance      */
/*                                                                        */
/*  OUTPUT                                                                */
/*                                                                        */
/*    None                                                                */
/*                                                                        */
/*  CALLS                                                                 */
/*                                                                        */
/*    _ux_utility_delay_ms                  Delay for some time           */
/*                                                                        */
/*  CALLED BY                                                             */
/*                                                                        */
/*    USBX                                                                */
/*                                                                        */
/**************************************************************************/
UINT  _ux_device_class_dfu_tasks_run(VOID *class_instance)
{

UX_SLAVE_CLASS_DFU              *dfu;
UX_SLAVE_DCD                    *dcd;
ULONG                           actual_flags;

    /* Get the dfu instance from this class container.  */
    dfu =  (UX_SLAVE_CLASS_DFU *) class_instance;

    /* Process when there is flags.  */
    if (dfu -> ux_device_class_dfu_flags == 0)
        return(UX_STATE_IDLE);
    actual_flags = dfu -> ux_device_class_dfu_flags;

    /* Check the source of event.  */
    if (actual_flags & UX_DEVICE_CLASS_DFU_THREAD_EVENT_DISCONNECT)
    {
        dfu -> ux_device_class_dfu_flags &= ~UX_DEVICE_CLASS_DFU_THREAD_EVENT_DISCONNECT;

        /* We need to disconnect.  The control command for DETACH is still being processed, wait 2-3 ms. */
        _ux_utility_delay_ms(2);

        /* Get the pointer to the DCD.  */
        dcd =  &_ux_system_slave -> ux_system_slave_dcd;

        /* Issue a Soft Disconnect.  */
        dcd -> ux_slave_dcd_function(dcd, UX_DCD_CHANGE_STATE, (VOID *) UX_DEVICE_FORCE_DISCONNECT);

    }

    /* Check the source of event.  */
    if (actual_flags & UX_DEVICE_CLASS_DFU_THREAD_EVENT_WAIT_RESET)
    {
        dfu -> ux_device_class_dfu_flags &= ~UX_DEVICE_CLASS_DFU_THREAD_EVENT_WAIT_RESET;

        /* We need to wait for reset.  Arm a timer.  The timeout value is indicated in ms from
            the device framework.  */
        _ux_utility_delay_ms(_ux_system_slave -> ux_system_slave_device_dfu_detach_timeout);

        /* Check the mode.  */
        if (_ux_system_slave -> ux_system_slave_device_dfu_mode ==  UX_DEVICE_CLASS_DFU_MODE_RUNTIME)

            /* We are still in RunTime mode. The host never reset. Revert to AppIdle state.  */
            _ux_system_slave -> ux_system_slave_device_dfu_state_machine = UX_SYSTEM_DFU_STATE_APP_IDLE;

    }
    return(UX_STATE_WAIT);
}
#endif