Head

GCC Code Coverage Report

Directory:	./		Exec	Total	Coverage
File:	usbx_host_classes/src/ux_host_class_hid_client_search.c	Lines:	23	23	100.0 %
Date:	2024-12-12 17:16:36	Branches:	10	10	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                                                        */
/**                                                                       */
/**   HID Class                                                           */
/**                                                                       */
/**************************************************************************/
/**************************************************************************/


/* Include necessary system files.  */

#define UX_SOURCE_CODE

#include "ux_api.h"
#include "ux_host_class_hid.h"
#include "ux_host_stack.h"


/**************************************************************************/
/*                                                                        */
/*  FUNCTION                                               RELEASE        */
/*                                                                        */
/*    _ux_host_class_hid_client_search                    PORTABLE C      */
/*                                                           6.1          */
/*  AUTHOR                                                                */
/*                                                                        */
/*    Chaoqiong Xiao, Microsoft Corporation                               */
/*                                                                        */
/*  DESCRIPTION                                                           */
/*                                                                        */
/*    This function searches for a HID client that wants to own this HID  */
/*    device.                                                             */
/*                                                                        */
/*  INPUT                                                                 */
/*                                                                        */
/*    hid                                   Pointer to HID class          */
/*                                                                        */
/*  OUTPUT                                                                */
/*                                                                        */
/*    Completion Status                                                   */
/*                                                                        */
/*  CALLS                                                                 */
/*                                                                        */
/*    (ux_host_class_hid_client_handler)    HID client handler            */
/*                                                                        */
/*  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    */
/*                                                                        */
/**************************************************************************/
UINT  _ux_host_class_hid_client_search(UX_HOST_CLASS_HID *hid)
{

UX_HOST_CLASS_HID_CLIENT            *hid_client;
ULONG                               hid_client_index;
UINT                                status;
UX_HOST_CLASS_HID_CLIENT_COMMAND    hid_client_command;


    /* In order to search a HID client, we need both the main page and the main usage.  */
    hid_client_command.ux_host_class_hid_client_command_page =       hid -> ux_host_class_hid_parser.ux_host_class_hid_parser_main_page;
    hid_client_command.ux_host_class_hid_client_command_usage =      hid -> ux_host_class_hid_parser.ux_host_class_hid_parser_main_usage & 0xffff;
    hid_client_command.ux_host_class_hid_client_command_instance =   hid;
    hid_client_command.ux_host_class_hid_client_command_container =  (VOID *) hid -> ux_host_class_hid_class;
    hid_client_command.ux_host_class_hid_client_command_request =    UX_HOST_CLASS_COMMAND_QUERY;

    /* Dereference the client pointer into a HID client pointer.  */
    hid_client =  (UX_HOST_CLASS_HID_CLIENT *) hid -> ux_host_class_hid_class -> ux_host_class_client;

    /* If the hid_client pointer is NULL, the array of clients was not initialized.  */
    if (hid_client == UX_NULL)
    {

        /* Error trap. */
        _ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD, UX_SYSTEM_CONTEXT_CLASS, UX_HOST_CLASS_HID_UNKNOWN);

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

        return(UX_HOST_CLASS_HID_UNKNOWN);
    }

    /* We need to parse the hid client driver table to find a registered client.  */
    for (hid_client_index = 0; hid_client_index < UX_HOST_CLASS_HID_MAX_CLIENTS; hid_client_index++)
    {

        /* Check if this HID client is registered. */
        if (hid_client -> ux_host_class_hid_client_status == UX_USED)
        {

            /* Call the HID client with a query command.  */
            status =  hid_client -> ux_host_class_hid_client_handler(&hid_client_command);

            /* Have we found a HID client?  */
            if (status == UX_SUCCESS)
            {

                /* Update the command to activate the client.  */
                hid_client_command.ux_host_class_hid_client_command_request =  UX_HOST_CLASS_COMMAND_ACTIVATE;

                /* Memorize the client for this HID device.  */
                hid -> ux_host_class_hid_client =  hid_client;

                /* Call the HID client with an activate command.  */
                status =  hid_client -> ux_host_class_hid_client_handler(&hid_client_command);

                /* Unmount the client if activation fail. */
                if (status != UX_SUCCESS)
                    hid -> ux_host_class_hid_client = UX_NULL;

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

        /* Try the next HID client.  */
        hid_client++;
    }

    /* Error trap. */
    _ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD, UX_SYSTEM_CONTEXT_CLASS, UX_HOST_CLASS_HID_UNKNOWN);

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

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



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			/** */
15			/** USBX Component */
16			/** */
17			/** HID Class */
18			/** */
19			/**************************************************************************/
20			/**************************************************************************/
21
22
23			/* Include necessary system files. */
24
25			#define UX_SOURCE_CODE
26
27			#include "ux_api.h"
28			#include "ux_host_class_hid.h"
29			#include "ux_host_stack.h"
30
31
32			/**************************************************************************/
33			/* */
34			/* FUNCTION RELEASE */
35			/* */
36			/* _ux_host_class_hid_client_search PORTABLE C */
37			/* 6.1 */
38			/* AUTHOR */
39			/* */
40			/* Chaoqiong Xiao, Microsoft Corporation */
41			/* */
42			/* DESCRIPTION */
43			/* */
44			/* This function searches for a HID client that wants to own this HID */
45			/* device. */
46			/* */
47			/* INPUT */
48			/* */
49			/* hid Pointer to HID class */
50			/* */
51			/* OUTPUT */
52			/* */
53			/* Completion Status */
54			/* */
55			/* CALLS */
56			/* */
57			/* (ux_host_class_hid_client_handler) HID client handler */
58			/* */
59			/* CALLED BY */
60			/* */
61			/* HID Class */
62			/* */
63			/* RELEASE HISTORY */
64			/* */
65			/* DATE NAME DESCRIPTION */
66			/* */
67			/* 05-19-2020 Chaoqiong Xiao Initial Version 6.0 */
68			/* 09-30-2020 Chaoqiong Xiao Modified comment(s), */
69			/* resulting in version 6.1 */
70			/* */
71			/**************************************************************************/
72		274	UINT _ux_host_class_hid_client_search(UX_HOST_CLASS_HID *hid)
73			{
74
75			UX_HOST_CLASS_HID_CLIENT *hid_client;
76			ULONG hid_client_index;
77			UINT status;
78			UX_HOST_CLASS_HID_CLIENT_COMMAND hid_client_command;
79
80
81			/* In order to search a HID client, we need both the main page and the main usage. */
82		274	hid_client_command.ux_host_class_hid_client_command_page = hid -> ux_host_class_hid_parser.ux_host_class_hid_parser_main_page;
83		274	hid_client_command.ux_host_class_hid_client_command_usage = hid -> ux_host_class_hid_parser.ux_host_class_hid_parser_main_usage & 0xffff;
84		274	hid_client_command.ux_host_class_hid_client_command_instance = hid;
85		274	hid_client_command.ux_host_class_hid_client_command_container = (VOID *) hid -> ux_host_class_hid_class;
86		274	hid_client_command.ux_host_class_hid_client_command_request = UX_HOST_CLASS_COMMAND_QUERY;
87
88			/* Dereference the client pointer into a HID client pointer. */
89		274	hid_client = (UX_HOST_CLASS_HID_CLIENT *) hid -> ux_host_class_hid_class -> ux_host_class_client;
90
91			/* If the hid_client pointer is NULL, the array of clients was not initialized. */
92	✓✓	274	if (hid_client == UX_NULL)
93			{
94
95			/* Error trap. */
96		32	_ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD, UX_SYSTEM_CONTEXT_CLASS, UX_HOST_CLASS_HID_UNKNOWN);
97
98			/* If trace is enabled, insert this event into the trace buffer. */
99			UX_TRACE_IN_LINE_INSERT(UX_TRACE_ERROR, UX_HOST_CLASS_HID_UNKNOWN, hid, 0, 0, UX_TRACE_ERRORS, 0, 0)
100
101		32	return(UX_HOST_CLASS_HID_UNKNOWN);
102			}
103
104			/* We need to parse the hid client driver table to find a registered client. */
105	✓✓	449	for (hid_client_index = 0; hid_client_index < UX_HOST_CLASS_HID_MAX_CLIENTS; hid_client_index++)
106			{
107
108			/* Check if this HID client is registered. */
109	✓✓	436	if (hid_client -> ux_host_class_hid_client_status == UX_USED)
110			{
111
112			/* Call the HID client with a query command. */
113		345	status = hid_client -> ux_host_class_hid_client_handler(&hid_client_command);
114
115			/* Have we found a HID client? */
116	✓✓	345	if (status == UX_SUCCESS)
117			{
118
119			/* Update the command to activate the client. */
120		229	hid_client_command.ux_host_class_hid_client_command_request = UX_HOST_CLASS_COMMAND_ACTIVATE;
121
122			/* Memorize the client for this HID device. */
123		229	hid -> ux_host_class_hid_client = hid_client;
124
125			/* Call the HID client with an activate command. */
126		229	status = hid_client -> ux_host_class_hid_client_handler(&hid_client_command);
127
128			/* Unmount the client if activation fail. */
129	✓✓	229	if (status != UX_SUCCESS)
130		26	hid -> ux_host_class_hid_client = UX_NULL;
131
132			/* Return completion status. */
133		229	return(status);
134			}
135			}
136
137			/* Try the next HID client. */
138		207	hid_client++;
139			}
140
141			/* Error trap. */
142		13	_ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD, UX_SYSTEM_CONTEXT_CLASS, UX_HOST_CLASS_HID_UNKNOWN);
143
144			/* If trace is enabled, insert this event into the trace buffer. */
145			UX_TRACE_IN_LINE_INSERT(UX_TRACE_ERROR, UX_HOST_CLASS_HID_UNKNOWN, hid, 0, 0, UX_TRACE_ERRORS, 0, 0)
146
147			/* Return an error. */
148		13	return(UX_HOST_CLASS_HID_UNKNOWN);
149			}
150