Head

GCC Code Coverage Report

Directory:	./		Exec	Total	Coverage
File:	usbx_device_classes/src/ux_device_class_hid_entry.c	Lines:	23	23	100.0 %
Date:	2024-12-12 17:16:36	Branches:	9	9	100.0 %


/***************************************************************************
 * Copyright (c) 2024 Microsoft Corporation
 *
 * 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 HID Class                                                    */
/**                                                                       */
/**************************************************************************/
/**************************************************************************/

#define UX_SOURCE_CODE


/* Include necessary system files.  */

#include "ux_api.h"
#include "ux_device_class_hid.h"
#include "ux_device_stack.h"


/**************************************************************************/
/*                                                                        */
/*  FUNCTION                                               RELEASE        */
/*                                                                        */
/*    _ux_device_class_hid_entry                          PORTABLE C      */
/*                                                           6.x          */
/*  AUTHOR                                                                */
/*                                                                        */
/*    Chaoqiong Xiao, Microsoft Corporation                               */
/*                                                                        */
/*  DESCRIPTION                                                           */
/*                                                                        */
/*    This function is the entry point of the hid class. It               */
/*    will be called by the device stack enumeration module when the      */
/*    host has sent a SET_CONFIGURATION command and the hid interface     */
/*    needs to be mounted.                                                */
/*                                                                        */
/*  INPUT                                                                 */
/*                                                                        */
/*    command                               Pointer to class command      */
/*                                                                        */
/*  OUTPUT                                                                */
/*                                                                        */
/*    Completion Status                                                   */
/*                                                                        */
/*  CALLS                                                                 */
/*                                                                        */
/*    _ux_device_class_hid_initialize       Initialize hid class          */
/*    _ux_device_class_hid_uninitialize     Uninitialize hid class        */
/*    _ux_device_class_hid_activate         Activate hid class            */
/*    _ux_device_class_hid_deactivate       Deactivate hid class          */
/*    _ux_device_class_hid_control_request  Request control               */
/*                                                                        */
/*  CALLED BY                                                             */
/*                                                                        */
/*    HID Class                                                           */
/*                                                                        */
/*  RELEASE HISTORY                                                       */
/*                                                                        */
/*    DATE              NAME                      DESCRIPTION             */
/*                                                                        */
/*  05-19-2020     Chaoqiong Xiao           Initial Version 6.0           */
/*  09-30-2020     Chaoqiong Xiao           Modified comment(s),          */
/*                                            resulting in version 6.1    */
/*  10-31-2023     Chaoqiong Xiao           Modified comment(s),          */
/*                                            added error checks support, */
/*                                            resulting in version 6.3.0  */
/*  xx-xx-xxxx     Mohamed ayed             Modified comment(s),          */
/*                                            fix typo,                   */
/*                                            remove extra spaces,        */
/*                                            resulting in version 6.x    */
/*                                                                        */
/**************************************************************************/
UINT  _ux_device_class_hid_entry(UX_SLAVE_CLASS_COMMAND *command)
{

UINT        status;


    /* The command request will tell us we need to do here, either a enumeration
       query, an activation or a deactivation.  */
    switch (command -> ux_slave_class_command_request)
    {

    case UX_SLAVE_CLASS_COMMAND_INITIALIZE:

        /* Call the init function of the HID class.  */
#if defined(UX_DEVICE_CLASS_HID_ENABLE_ERROR_CHECKING)
        status =  _uxe_device_class_hid_initialize(command);
#else
        status =  _ux_device_class_hid_initialize(command);
#endif

        /* Return the completion status.  */
        return(status);

    case UX_SLAVE_CLASS_COMMAND_UNINITIALIZE:

        /* Call the uninit function of the HID class.  */
        status =  _ux_device_class_hid_uninitialize(command);

        /* Return the completion status.  */
        return(status);

    case UX_SLAVE_CLASS_COMMAND_QUERY:

        /* Check the CLASS definition in the interface descriptor. */
        if (command -> ux_slave_class_command_class == UX_DEVICE_CLASS_HID_CLASS)
            return(UX_SUCCESS);
        else
            return(UX_NO_CLASS_MATCH);

    case UX_SLAVE_CLASS_COMMAND_ACTIVATE:

        /* The activate command is used when the host has sent a SET_CONFIGURATION command
           and this interface has to be mounted. Both Bulk endpoints have to be mounted
           and the hid thread needs to be activated.  */
        status =  _ux_device_class_hid_activate(command);

        /* Return the completion status.  */
        return(status);

    case UX_SLAVE_CLASS_COMMAND_DEACTIVATE:

        /* The deactivate command is used when the device has been extracted.
           The device endpoints have to be dismounted and the hid thread canceled.  */
        status =  _ux_device_class_hid_deactivate(command);

        /* Return the completion status.  */
        return(status);

    case UX_SLAVE_CLASS_COMMAND_REQUEST:

        /* The request command is used when the host sends a command on the control endpoint.  */
        status = _ux_device_class_hid_control_request(command);

        /* Return the completion status.  */
        return(status);

    default:

        /* If trace is enabled, insert this event into the trace buffer.  */
        UX_TRACE_IN_LINE_INSERT(UX_TRACE_ERROR, UX_FUNCTION_NOT_SUPPORTED, 0, 0, 0, UX_TRACE_ERRORS, 0, 0)

        /* Return an error.  */
        return(UX_FUNCTION_NOT_SUPPORTED);
    }
}



Generated by: GCOVR (Version 4.1)

Line	Branch	Exec	Source
1			/***************************************************************************
2			* Copyright (c) 2024 Microsoft Corporation
3			*
4			* This program and the accompanying materials are made available under the
5			* terms of the MIT License which is available at
6			* https://opensource.org/licenses/MIT.
7			*
8			* SPDX-License-Identifier: MIT
9			**************************************************************************/
10
11			/**************************************************************************/
12			/**************************************************************************/
13			/** */
14			/** USBX Component */
15			/** */
16			/** Device HID Class */
17			/** */
18			/**************************************************************************/
19			/**************************************************************************/
20
21			#define UX_SOURCE_CODE
22
23
24			/* Include necessary system files. */
25
26			#include "ux_api.h"
27			#include "ux_device_class_hid.h"
28			#include "ux_device_stack.h"
29
30
31			/**************************************************************************/
32			/* */
33			/* FUNCTION RELEASE */
34			/* */
35			/* _ux_device_class_hid_entry PORTABLE C */
36			/* 6.x */
37			/* AUTHOR */
38			/* */
39			/* Chaoqiong Xiao, Microsoft Corporation */
40			/* */
41			/* DESCRIPTION */
42			/* */
43			/* This function is the entry point of the hid class. It */
44			/* will be called by the device stack enumeration module when the */
45			/* host has sent a SET_CONFIGURATION command and the hid interface */
46			/* needs to be mounted. */
47			/* */
48			/* INPUT */
49			/* */
50			/* command Pointer to class command */
51			/* */
52			/* OUTPUT */
53			/* */
54			/* Completion Status */
55			/* */
56			/* CALLS */
57			/* */
58			/* _ux_device_class_hid_initialize Initialize hid class */
59			/* _ux_device_class_hid_uninitialize Uninitialize hid class */
60			/* _ux_device_class_hid_activate Activate hid class */
61			/* _ux_device_class_hid_deactivate Deactivate hid class */
62			/* _ux_device_class_hid_control_request Request control */
63			/* */
64			/* CALLED BY */
65			/* */
66			/* HID Class */
67			/* */
68			/* RELEASE HISTORY */
69			/* */
70			/* DATE NAME DESCRIPTION */
71			/* */
72			/* 05-19-2020 Chaoqiong Xiao Initial Version 6.0 */
73			/* 09-30-2020 Chaoqiong Xiao Modified comment(s), */
74			/* resulting in version 6.1 */
75			/* 10-31-2023 Chaoqiong Xiao Modified comment(s), */
76			/* added error checks support, */
77			/* resulting in version 6.3.0 */
78			/* xx-xx-xxxx Mohamed ayed Modified comment(s), */
79			/* fix typo, */
80			/* remove extra spaces, */
81			/* resulting in version 6.x */
82			/* */
83			/**************************************************************************/
84		3269	UINT _ux_device_class_hid_entry(UX_SLAVE_CLASS_COMMAND *command)
85			{
86
87			UINT status;
88
89
90			/* The command request will tell us we need to do here, either a enumeration
91			query, an activation or a deactivation. */
92	✓✓✓✓ ✓✓✓	3269	switch (command -> ux_slave_class_command_request)
93			{
94
95		204	case UX_SLAVE_CLASS_COMMAND_INITIALIZE:
96
97			/* Call the init function of the HID class. */
98			#if defined(UX_DEVICE_CLASS_HID_ENABLE_ERROR_CHECKING)
99			status = _uxe_device_class_hid_initialize(command);
100			#else
101		204	status = _ux_device_class_hid_initialize(command);
102			#endif
103
104			/* Return the completion status. */
105		204	return(status);
106
107		158	case UX_SLAVE_CLASS_COMMAND_UNINITIALIZE:
108
109			/* Call the uninit function of the HID class. */
110		158	status = _ux_device_class_hid_uninitialize(command);
111
112			/* Return the completion status. */
113		158	return(status);
114
115		691	case UX_SLAVE_CLASS_COMMAND_QUERY:
116
117			/* Check the CLASS definition in the interface descriptor. */
118	✓✓	691	if (command -> ux_slave_class_command_class == UX_DEVICE_CLASS_HID_CLASS)
119		690	return(UX_SUCCESS);
120			else
121		1	return(UX_NO_CLASS_MATCH);
122
123		690	case UX_SLAVE_CLASS_COMMAND_ACTIVATE:
124
125			/* The activate command is used when the host has sent a SET_CONFIGURATION command
126			and this interface has to be mounted. Both Bulk endpoints have to be mounted
127			and the hid thread needs to be activated. */
128		690	status = _ux_device_class_hid_activate(command);
129
130			/* Return the completion status. */
131		690	return(status);
132
133		677	case UX_SLAVE_CLASS_COMMAND_DEACTIVATE:
134
135			/* The deactivate command is used when the device has been extracted.
136			The device endpoints have to be dismounted and the hid thread canceled. */
137		677	status = _ux_device_class_hid_deactivate(command);
138
139			/* Return the completion status. */
140		677	return(status);
141
142		848	case UX_SLAVE_CLASS_COMMAND_REQUEST:
143
144			/* The request command is used when the host sends a command on the control endpoint. */
145		848	status = _ux_device_class_hid_control_request(command);
146
147			/* Return the completion status. */
148		848	return(status);
149
150		1	default:
151
152			/* If trace is enabled, insert this event into the trace buffer. */
153			UX_TRACE_IN_LINE_INSERT(UX_TRACE_ERROR, UX_FUNCTION_NOT_SUPPORTED, 0, 0, 0, UX_TRACE_ERRORS, 0, 0)
154
155			/* Return an error. */
156		1	return(UX_FUNCTION_NOT_SUPPORTED);
157			}
158			}
159