dlls/hid/hidp.c

   1 /*
   2  * Human Input Devices
   3  *
   4  * Copyright (C) 2015 Aric Stewart
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  19  */
  20
  21
  22 #include <stdarg.h>
  23
  24 #include "ntstatus.h"
  25 #define WIN32_NO_STATUS
  26 #include "windef.h"
  27 #include "winbase.h"
  28 #include "winternl.h"
  29 #include "winioctl.h"
  30 #include "ddk/wdm.h"
  31
  32 #include "hidusage.h"
  33 #include "ddk/hidpi.h"
  34 #include "wine/hid.h"
  35 #include "wine/debug.h"
  36
  37 WINE_DEFAULT_DEBUG_CHANNEL(hidp);
  38
  39 static NTSTATUS get_value_caps_range( WINE_HIDP_PREPARSED_DATA *preparsed, HIDP_REPORT_TYPE report_type, ULONG report_len,
  40                                       const struct hid_value_caps **caps, const struct hid_value_caps **caps_end )
  41 {
  42     if (preparsed->magic != HID_MAGIC) return HIDP_STATUS_INVALID_PREPARSED_DATA;
  43
  44     switch (report_type)
  45     {
  46     case HidP_Input:
  47         if (report_len && report_len != preparsed->caps.InputReportByteLength)
  48             return HIDP_STATUS_INVALID_REPORT_LENGTH;
  49         *caps = HID_INPUT_VALUE_CAPS( preparsed );
  50         break;
  51     case HidP_Output:
  52         if (report_len && report_len != preparsed->caps.OutputReportByteLength)
  53             return HIDP_STATUS_INVALID_REPORT_LENGTH;
  54         *caps = HID_OUTPUT_VALUE_CAPS( preparsed );
  55         break;
  56     case HidP_Feature:
  57         if (report_len && report_len != preparsed->caps.FeatureReportByteLength)
  58             return HIDP_STATUS_INVALID_REPORT_LENGTH;
  59         *caps = HID_FEATURE_VALUE_CAPS( preparsed );
  60         break;
  61     default:
  62         return HIDP_STATUS_INVALID_REPORT_TYPE;
  63     }
  64
  65     *caps_end = *caps + preparsed->value_caps_count[report_type];
  66     return HIDP_STATUS_SUCCESS;
  67 }
  68
  69 struct caps_filter
  70 {
  71     BOOLEAN buttons;
  72     BOOLEAN values;
  73     BOOLEAN array;
  74     USAGE   usage_page;
  75     USHORT  collection;
  76     USAGE   usage;
  77     UCHAR   report_id;
  78 };
  79
  80 static BOOL match_value_caps( const struct hid_value_caps *caps, const struct caps_filter *filter )
  81 {
  82     if (!caps->usage_min && !caps->usage_max) return FALSE;
  83     if (filter->buttons && !HID_VALUE_CAPS_IS_BUTTON( caps )) return FALSE;
  84     if (filter->values && HID_VALUE_CAPS_IS_BUTTON( caps )) return FALSE;
  85     if (filter->usage_page && filter->usage_page != caps->usage_page) return FALSE;
  86     if (filter->collection && filter->collection != caps->link_collection) return FALSE;
  87     if (!filter->usage) return TRUE;
  88     return caps->usage_min <= filter->usage && caps->usage_max >= filter->usage;
  89 }
  90
  91 typedef NTSTATUS (*enum_value_caps_callback)( const struct hid_value_caps *caps, void *user );
  92
  93 static NTSTATUS enum_value_caps( WINE_HIDP_PREPARSED_DATA *preparsed, HIDP_REPORT_TYPE report_type,
  94                                  ULONG report_len, const struct caps_filter *filter,
  95                                  enum_value_caps_callback callback, void *user, USHORT *count )
  96 {
  97     const struct hid_value_caps *caps, *caps_end;
  98     NTSTATUS status;
  99     BOOL incompatible = FALSE;
 100     LONG remaining = *count;
 101
 102     for (status = get_value_caps_range( preparsed, report_type, report_len, &caps, &caps_end );
 103          status == HIDP_STATUS_SUCCESS && caps != caps_end; caps++)
 104     {
 105         if (!match_value_caps( caps, filter )) continue;
 106         if (filter->report_id && caps->report_id != filter->report_id) incompatible = TRUE;
 107         else if (filter->array && (caps->is_range || caps->report_count <= 1)) return HIDP_STATUS_NOT_VALUE_ARRAY;
 108         else if (remaining-- > 0) status = callback( caps, user );
 109     }
 110
 111     if (status == HIDP_STATUS_NULL) status = HIDP_STATUS_SUCCESS;
 112     if (status != HIDP_STATUS_SUCCESS) return status;
 113
 114     *count -= remaining;
 115     if (*count == 0) return incompatible ? HIDP_STATUS_INCOMPATIBLE_REPORT_ID : HIDP_STATUS_USAGE_NOT_FOUND;
 116     if (remaining < 0) return HIDP_STATUS_BUFFER_TOO_SMALL;
 117     return HIDP_STATUS_SUCCESS;
 118 }
 119
 120 /* copy count bits from src, starting at (-shift) bit if < 0, to dst starting at (shift) bit if > 0 */
 121 static void copy_bits( unsigned char *dst, const unsigned char *src, int count, int shift )
 122 {
 123     unsigned char bits, mask;
 124     size_t src_shift = shift < 0 ? (-shift & 7) : 0;
 125     size_t dst_shift = shift > 0 ? (shift & 7) : 0;
 126     if (shift < 0) src += -shift / 8;
 127     if (shift > 0) dst += shift / 8;
 128
 129     if (src_shift == 0 && dst_shift == 0)
 130     {
 131         memcpy( dst, src, count / 8 );
 132         dst += count / 8;
 133         src += count / 8;
 134         count &= 7;
 135     }
 136
 137     if (!count) return;
 138
 139     bits = *dst << (8 - dst_shift);
 140     count += dst_shift;
 141
 142     while (count > 8)
 143     {
 144         *dst = bits >> (8 - dst_shift);
 145         bits = *(unsigned short *)src++ >> src_shift;
 146         *dst++ |= bits << dst_shift;
 147         count -= 8;
 148     }
 149
 150     bits >>= (8 - dst_shift);
 151     if (count <= 8 - src_shift) bits |= (*src >> src_shift) << dst_shift;
 152     else bits |= (*(unsigned short *)src >> src_shift) << dst_shift;
 153
 154     mask = (1 << count) - 1;
 155     *dst = (bits & mask) | (*dst & ~mask);
 156 }
 157
 158 NTSTATUS WINAPI HidP_GetButtonCaps( HIDP_REPORT_TYPE report_type, HIDP_BUTTON_CAPS *caps, USHORT *caps_count,
 159                                     PHIDP_PREPARSED_DATA preparsed_data )
 160 {
 161     return HidP_GetSpecificButtonCaps( report_type, 0, 0, 0, caps, caps_count, preparsed_data );
 162 }
 163
 164 NTSTATUS WINAPI HidP_GetCaps( PHIDP_PREPARSED_DATA preparsed_data, HIDP_CAPS *caps )
 165 {
 166     WINE_HIDP_PREPARSED_DATA *preparsed = (WINE_HIDP_PREPARSED_DATA *)preparsed_data;
 167
 168     TRACE( "preparsed_data %p, caps %p.\n", preparsed_data, caps );
 169
 170     if (preparsed->magic != HID_MAGIC) return HIDP_STATUS_INVALID_PREPARSED_DATA;
 171
 172     *caps = preparsed->caps;
 173     return HIDP_STATUS_SUCCESS;
 174 }
 175
 176 struct usage_value_params
 177 {
 178     void *value_buf;
 179     USHORT value_len;
 180     void *report_buf;
 181 };
 182
 183 static LONG sign_extend( ULONG value, const struct hid_value_caps *caps )
 184 {
 185     UINT sign = 1 << (caps->bit_size - 1);
 186     if (sign <= 1 || caps->logical_min >= 0) return value;
 187     return value - ((value & sign) << 1);
 188 }
 189
 190 static NTSTATUS get_scaled_usage_value( const struct hid_value_caps *caps, void *user )
 191 {
 192     struct usage_value_params *params = user;
 193     ULONG unsigned_value = 0, bit_count = caps->bit_size * caps->report_count;
 194     LONG signed_value, *value = params->value_buf;
 195
 196     if ((bit_count + 7) / 8 > sizeof(unsigned_value)) return HIDP_STATUS_BUFFER_TOO_SMALL;
 197     if (sizeof(LONG) > params->value_len) return HIDP_STATUS_BUFFER_TOO_SMALL;
 198     copy_bits( (unsigned char *)&unsigned_value, params->report_buf, bit_count, -caps->start_bit );
 199     signed_value = sign_extend( unsigned_value, caps );
 200
 201     if (caps->logical_min > caps->logical_max || caps->physical_min > caps->physical_max)
 202         return HIDP_STATUS_BAD_LOG_PHY_VALUES;
 203     if (caps->logical_min > signed_value || caps->logical_max < signed_value)
 204         return HIDP_STATUS_VALUE_OUT_OF_RANGE;
 205
 206     if (!caps->physical_min && !caps->physical_max) *value = signed_value;
 207     else *value = caps->physical_min + MulDiv( signed_value - caps->logical_min, caps->physical_max - caps->physical_min,
 208                                                caps->logical_max - caps->logical_min );
 209     return HIDP_STATUS_NULL;
 210 }
 211
 212 NTSTATUS WINAPI HidP_GetScaledUsageValue( HIDP_REPORT_TYPE report_type, USAGE usage_page, USHORT collection,
 213                                           USAGE usage, LONG *value, PHIDP_PREPARSED_DATA preparsed_data,
 214                                           char *report_buf, ULONG report_len )
 215 {
 216     struct usage_value_params params = {.value_buf = value, .value_len = sizeof(*value), .report_buf = report_buf};
 217     WINE_HIDP_PREPARSED_DATA *preparsed = (WINE_HIDP_PREPARSED_DATA *)preparsed_data;
 218     struct caps_filter filter = {.values = TRUE, .usage_page = usage_page, .collection = collection, .usage = usage };
 219     USHORT count = 1;
 220
 221     TRACE( "report_type %d, usage_page %x, collection %d, usage %x, value %p, preparsed_data %p, report_buf %p, report_len %u.\n",
 222            report_type, usage_page, collection, usage, value, preparsed_data, report_buf, report_len );
 223
 224     *value = 0;
 225     if (!report_len) return HIDP_STATUS_INVALID_REPORT_LENGTH;
 226
 227     filter.report_id = report_buf[0];
 228     return enum_value_caps( preparsed, report_type, report_len, &filter, get_scaled_usage_value, &params, &count );
 229 }
 230
 231 static NTSTATUS get_usage_value( const struct hid_value_caps *caps, void *user )
 232 {
 233     struct usage_value_params *params = user;
 234     ULONG bit_count = caps->bit_size * caps->report_count;
 235     if ((bit_count + 7) / 8 > params->value_len) return HIDP_STATUS_BUFFER_TOO_SMALL;
 236     memset( params->value_buf, 0, params->value_len );
 237     copy_bits( params->value_buf, params->report_buf, bit_count, -caps->start_bit );
 238     return HIDP_STATUS_NULL;
 239 }
 240
 241 NTSTATUS WINAPI HidP_GetUsageValue( HIDP_REPORT_TYPE report_type, USAGE usage_page, USHORT collection, USAGE usage,
 242                                     ULONG *value, PHIDP_PREPARSED_DATA preparsed_data, char *report_buf, ULONG report_len )
 243 {
 244     struct usage_value_params params = {.value_buf = value, .value_len = sizeof(*value), .report_buf = report_buf};
 245     WINE_HIDP_PREPARSED_DATA *preparsed = (WINE_HIDP_PREPARSED_DATA *)preparsed_data;
 246     struct caps_filter filter = {.values = TRUE, .usage_page = usage_page, .collection = collection, .usage = usage};
 247     USHORT count = 1;
 248
 249     TRACE( "report_type %d, usage_page %x, collection %d, usage %x, value %p, preparsed_data %p, report_buf %p, report_len %u.\n",
 250            report_type, usage_page, collection, usage, value, preparsed_data, report_buf, report_len );
 251
 252     if (!report_len) return HIDP_STATUS_INVALID_REPORT_LENGTH;
 253
 254     filter.report_id = report_buf[0];
 255     return enum_value_caps( preparsed, report_type, report_len, &filter, get_usage_value, &params, &count );
 256 }
 257
 258 NTSTATUS WINAPI HidP_GetUsageValueArray( HIDP_REPORT_TYPE report_type, USAGE usage_page, USHORT collection,
 259                                          USAGE usage, char *value_buf, USHORT value_len,
 260                                          PHIDP_PREPARSED_DATA preparsed_data, char *report_buf, ULONG report_len )
 261 {
 262     struct usage_value_params params = {.value_buf = value_buf, .value_len = value_len, .report_buf = report_buf};
 263     WINE_HIDP_PREPARSED_DATA *preparsed = (WINE_HIDP_PREPARSED_DATA *)preparsed_data;
 264     struct caps_filter filter = {.values = TRUE, .array = TRUE, .usage_page = usage_page, .collection = collection, .usage = usage};
 265     USHORT count = 1;
 266
 267     TRACE( "report_type %d, usage_page %x, collection %d, usage %x, value_buf %p, value_len %u, "
 268            "preparsed_data %p, report_buf %p, report_len %u.\n",
 269            report_type, usage_page, collection, usage, value_buf, value_len, preparsed_data, report_buf, report_len );
 270
 271     if (!report_len) return HIDP_STATUS_INVALID_REPORT_LENGTH;
 272
 273     filter.report_id = report_buf[0];
 274     return enum_value_caps( preparsed, report_type, report_len, &filter, get_usage_value, &params, &count );
 275 }
 276
 277
 278 struct get_usage_params
 279 {
 280     USAGE *usages;
 281     USAGE *usages_end;
 282     char *report_buf;
 283 };
 284
 285 static NTSTATUS get_usage( const struct hid_value_caps *caps, void *user )
 286 {
 287     struct get_usage_params *params = user;
 288     ULONG bit, last;
 289     BYTE index;
 290
 291     if (HID_VALUE_CAPS_IS_ARRAY( caps ))
 292     {
 293         for (bit = caps->start_bit, last = bit + caps->report_count * caps->bit_size - 1; bit <= last; bit += 8)
 294         {
 295             if (!(index = params->report_buf[bit / 8])) continue;
 296             if (params->usages < params->usages_end) *params->usages = caps->usage_min + index - caps->start_index;
 297             params->usages++;
 298         }
 299         return HIDP_STATUS_SUCCESS;
 300     }
 301
 302     for (bit = caps->start_bit, last = bit + caps->usage_max - caps->usage_min; bit <= last; ++bit)
 303     {
 304         if (!(params->report_buf[bit / 8] & (1 << (bit % 8)))) continue;
 305         if (params->usages < params->usages_end) *params->usages = caps->usage_min + bit - caps->start_bit;
 306         params->usages++;
 307     }
 308
 309     return HIDP_STATUS_SUCCESS;
 310 }
 311
 312 NTSTATUS WINAPI HidP_GetUsages( HIDP_REPORT_TYPE report_type, USAGE usage_page, USHORT collection, USAGE *usages,
 313                                 ULONG *usages_len, PHIDP_PREPARSED_DATA preparsed_data, char *report_buf, ULONG report_len )
 314 {
 315     WINE_HIDP_PREPARSED_DATA *preparsed = (WINE_HIDP_PREPARSED_DATA *)preparsed_data;
 316     struct get_usage_params params = {.usages = usages, .usages_end = usages + *usages_len, .report_buf = report_buf};
 317     struct caps_filter filter = {.buttons = TRUE, .usage_page = usage_page, .collection = collection};
 318     NTSTATUS status;
 319     USHORT limit = -1;
 320
 321     TRACE( "report_type %d, collection %d, usages %p, usages_len %p, preparsed_data %p, report_buf %p, report_len %u.\n",
 322            report_type, collection, usages, usages_len, preparsed_data, report_buf, report_len );
 323
 324     if (!report_len) return HIDP_STATUS_INVALID_REPORT_LENGTH;
 325
 326     filter.report_id = report_buf[0];
 327     status = enum_value_caps( preparsed, report_type, report_len, &filter, get_usage, &params, &limit );
 328     *usages_len = params.usages - usages;
 329     if (status != HIDP_STATUS_SUCCESS) return status;
 330
 331     if (*usages_len == 0) return HIDP_STATUS_USAGE_NOT_FOUND;
 332     if (params.usages > params.usages_end) return HIDP_STATUS_BUFFER_TOO_SMALL;
 333     return status;
 334 }
 335
 336 NTSTATUS WINAPI HidP_GetValueCaps( HIDP_REPORT_TYPE report_type, HIDP_VALUE_CAPS *caps, USHORT *caps_count,
 337                                    PHIDP_PREPARSED_DATA preparsed_data )
 338 {
 339     return HidP_GetSpecificValueCaps( report_type, 0, 0, 0, caps, caps_count, preparsed_data );
 340 }
 341
 342 NTSTATUS WINAPI HidP_InitializeReportForID( HIDP_REPORT_TYPE report_type, UCHAR report_id,
 343                                             PHIDP_PREPARSED_DATA preparsed_data, char *report_buf, ULONG report_len )
 344 {
 345     WINE_HIDP_PREPARSED_DATA *preparsed = (WINE_HIDP_PREPARSED_DATA *)preparsed_data;
 346     const struct hid_value_caps *caps, *end;
 347     NTSTATUS status;
 348
 349     TRACE( "report_type %d, report_id %x, preparsed_data %p, report_buf %p, report_len %u.\n", report_type,
 350            report_id, preparsed_data, report_buf, report_len );
 351
 352     if (!report_len) return HIDP_STATUS_INVALID_REPORT_LENGTH;
 353
 354     status = get_value_caps_range( preparsed, report_type, report_len, &caps, &end );
 355     if (status != HIDP_STATUS_SUCCESS) return status;
 356
 357     while (caps != end && (caps->report_id != report_id || (!caps->usage_min && !caps->usage_max))) caps++;
 358     if (caps == end) return HIDP_STATUS_REPORT_DOES_NOT_EXIST;
 359
 360     memset( report_buf, 0, report_len );
 361     report_buf[0] = report_id;
 362     return HIDP_STATUS_SUCCESS;
 363 }
 364
 365 static NTSTATUS get_usage_list_length( const struct hid_value_caps *caps, void *data )
 366 {
 367     *(ULONG *)data += caps->report_count;
 368     return HIDP_STATUS_SUCCESS;
 369 }
 370
 371 ULONG WINAPI HidP_MaxUsageListLength( HIDP_REPORT_TYPE report_type, USAGE usage_page, PHIDP_PREPARSED_DATA preparsed_data )
 372 {
 373     WINE_HIDP_PREPARSED_DATA *preparsed = (WINE_HIDP_PREPARSED_DATA *)preparsed_data;
 374     struct caps_filter filter = {.buttons = TRUE, .usage_page = usage_page};
 375     USHORT limit = -1;
 376     ULONG count = 0;
 377
 378     TRACE( "report_type %d, usage_page %x, preparsed_data %p.\n", report_type, usage_page, preparsed_data );
 379
 380     enum_value_caps( preparsed, report_type, 0, &filter, get_usage_list_length, &count, &limit );
 381     return count;
 382 }
 383
 384 static NTSTATUS set_usage_value( const struct hid_value_caps *caps, void *user )
 385 {
 386     struct usage_value_params *params = user;
 387     ULONG bit_count = caps->bit_size * caps->report_count;
 388     if ((bit_count + 7) / 8 > params->value_len) return HIDP_STATUS_BUFFER_TOO_SMALL;
 389     copy_bits( params->report_buf, params->value_buf, bit_count, caps->start_bit );
 390     return HIDP_STATUS_NULL;
 391 }
 392
 393 NTSTATUS WINAPI HidP_SetUsageValue( HIDP_REPORT_TYPE report_type, USAGE usage_page, USHORT collection, USAGE usage,
 394                                     ULONG value, PHIDP_PREPARSED_DATA preparsed_data, char *report_buf, ULONG report_len )
 395 {
 396     struct usage_value_params params = {.value_buf = &value, .value_len = sizeof(value), .report_buf = report_buf};
 397     WINE_HIDP_PREPARSED_DATA *preparsed = (WINE_HIDP_PREPARSED_DATA *)preparsed_data;
 398     struct caps_filter filter = {.values = TRUE, .usage_page = usage_page, .collection = collection, .usage = usage};
 399     USHORT count = 1;
 400
 401     TRACE( "report_type %d, usage_page %x, collection %d, usage %x, value %u, preparsed_data %p, report_buf %p, report_len %u.\n",
 402            report_type, usage_page, collection, usage, value, preparsed_data, report_buf, report_len );
 403
 404     if (!report_len) return HIDP_STATUS_INVALID_REPORT_LENGTH;
 405
 406     filter.report_id = report_buf[0];
 407     return enum_value_caps( preparsed, report_type, report_len, &filter, set_usage_value, &params, &count );
 408 }
 409
 410 NTSTATUS WINAPI HidP_SetUsageValueArray( HIDP_REPORT_TYPE report_type, USAGE usage_page, USHORT collection,
 411                                          USAGE usage, char *value_buf, USHORT value_len,
 412                                          PHIDP_PREPARSED_DATA preparsed_data, char *report_buf, ULONG report_len )
 413 {
 414     struct usage_value_params params = {.value_buf = value_buf, .value_len = value_len, .report_buf = report_buf};
 415     WINE_HIDP_PREPARSED_DATA *preparsed = (WINE_HIDP_PREPARSED_DATA *)preparsed_data;
 416     struct caps_filter filter = {.values = TRUE, .array = TRUE, .usage_page = usage_page, .collection = collection, .usage = usage};
 417     USHORT count = 1;
 418
 419     TRACE( "report_type %d, usage_page %x, collection %d, usage %x, value_buf %p, value_len %u, "
 420            "preparsed_data %p, report_buf %p, report_len %u.\n",
 421            report_type, usage_page, collection, usage, value_buf, value_len, preparsed_data, report_buf, report_len );
 422
 423     if (!report_len) return HIDP_STATUS_INVALID_REPORT_LENGTH;
 424
 425     filter.report_id = report_buf[0];
 426     return enum_value_caps( preparsed, report_type, report_len, &filter, set_usage_value, &params, &count );
 427 }
 428
 429 struct set_usage_params
 430 {
 431     USAGE usage;
 432     char *report_buf;
 433 };
 434
 435 static NTSTATUS set_usage( const struct hid_value_caps *caps, void *user )
 436 {
 437     struct set_usage_params *params = user;
 438     ULONG bit, last;
 439
 440     if (HID_VALUE_CAPS_IS_ARRAY( caps ))
 441     {
 442         for (bit = caps->start_bit, last = bit + caps->report_count * caps->bit_size - 1; bit <= last; bit += 8)
 443         {
 444             if (params->report_buf[bit / 8]) continue;
 445             params->report_buf[bit / 8] = caps->start_index + params->usage - caps->usage_min;
 446             break;
 447         }
 448
 449         if (bit > last) return HIDP_STATUS_BUFFER_TOO_SMALL;
 450         return HIDP_STATUS_NULL;
 451     }
 452
 453     bit = caps->start_bit + params->usage - caps->usage_min;
 454     params->report_buf[bit / 8] |= (1 << (bit % 8));
 455     return HIDP_STATUS_NULL;
 456 }
 457
 458 NTSTATUS WINAPI HidP_SetUsages( HIDP_REPORT_TYPE report_type, USAGE usage_page, USHORT collection, USAGE *usages,
 459                                 ULONG *usage_count, PHIDP_PREPARSED_DATA preparsed_data, char *report_buf, ULONG report_len )
 460 {
 461     WINE_HIDP_PREPARSED_DATA *preparsed = (WINE_HIDP_PREPARSED_DATA *)preparsed_data;
 462     struct set_usage_params params = {.report_buf = report_buf};
 463     struct caps_filter filter = {.buttons = TRUE, .usage_page = usage_page, .collection = collection};
 464     NTSTATUS status;
 465     USHORT limit = 1;
 466     ULONG i, count = *usage_count;
 467
 468     TRACE( "report_type %d, usage_page %x, collection %d, usages %p, usage_count %p, preparsed_data %p, "
 469            "report_buf %p, report_len %u.\n",
 470            report_type, usage_page, collection, usages, usage_count, preparsed_data, report_buf, report_len );
 471
 472     if (!report_len) return HIDP_STATUS_INVALID_REPORT_LENGTH;
 473
 474     filter.report_id = report_buf[0];
 475     for (i = 0; i < count; ++i)
 476     {
 477         params.usage = filter.usage = usages[i];
 478         status = enum_value_caps( preparsed, report_type, report_len, &filter, set_usage, &params, &limit );
 479         if (status != HIDP_STATUS_SUCCESS) return status;
 480     }
 481
 482     return HIDP_STATUS_SUCCESS;
 483 }
 484
 485
 486 NTSTATUS WINAPI HidP_TranslateUsagesToI8042ScanCodes(USAGE *ChangedUsageList,
 487     ULONG UsageListLength, HIDP_KEYBOARD_DIRECTION KeyAction,
 488     HIDP_KEYBOARD_MODIFIER_STATE *ModifierState,
 489     PHIDP_INSERT_SCANCODES InsertCodesProcedure, VOID *InsertCodesContext)
 490 {
 491     FIXME("stub: %p, %i, %i, %p, %p, %p\n", ChangedUsageList, UsageListLength,
 492         KeyAction, ModifierState, InsertCodesProcedure, InsertCodesContext);
 493
 494     return STATUS_NOT_IMPLEMENTED;
 495 }
 496
 497 static NTSTATUS get_button_caps( const struct hid_value_caps *caps, void *user )
 498 {
 499     HIDP_BUTTON_CAPS **iter = user, *dst = *iter;
 500     dst->UsagePage = caps->usage_page;
 501     dst->ReportID = caps->report_id;
 502     dst->LinkCollection = caps->link_collection;
 503     dst->LinkUsagePage = caps->link_usage_page;
 504     dst->LinkUsage = caps->link_usage;
 505     dst->BitField = caps->bit_field;
 506     dst->IsAlias = FALSE;
 507     dst->IsAbsolute = HID_VALUE_CAPS_IS_ABSOLUTE( caps );
 508     if (!(dst->IsRange = caps->is_range))
 509     {
 510         dst->NotRange.Usage = caps->usage_min;
 511         dst->NotRange.DataIndex = caps->data_index_min;
 512     }
 513     else
 514     {
 515         dst->Range.UsageMin = caps->usage_min;
 516         dst->Range.UsageMax = caps->usage_max;
 517         dst->Range.DataIndexMin = caps->data_index_min;
 518         dst->Range.DataIndexMax = caps->data_index_max;
 519     }
 520     if (!(dst->IsStringRange = caps->is_string_range))
 521         dst->NotRange.StringIndex = caps->string_min;
 522     else
 523     {
 524         dst->Range.StringMin = caps->string_min;
 525         dst->Range.StringMax = caps->string_max;
 526     }
 527     if ((dst->IsDesignatorRange = caps->is_designator_range))
 528         dst->NotRange.DesignatorIndex = caps->designator_min;
 529     else
 530     {
 531         dst->Range.DesignatorMin = caps->designator_min;
 532         dst->Range.DesignatorMax = caps->designator_max;
 533     }
 534     *iter += 1;
 535     return HIDP_STATUS_SUCCESS;
 536 }
 537
 538 NTSTATUS WINAPI HidP_GetSpecificButtonCaps( HIDP_REPORT_TYPE report_type, USAGE usage_page, USHORT collection,
 539                                             USAGE usage, HIDP_BUTTON_CAPS *caps, USHORT *caps_count,
 540                                             PHIDP_PREPARSED_DATA preparsed_data )
 541 {
 542     WINE_HIDP_PREPARSED_DATA *preparsed = (WINE_HIDP_PREPARSED_DATA *)preparsed_data;
 543     const struct caps_filter filter = {.buttons = TRUE, .usage_page = usage_page, .collection = collection, .usage = usage};
 544
 545     TRACE( "report_type %d, usage_page %x, collection %d, usage %x, caps %p, caps_count %p, preparsed_data %p.\n",
 546            report_type, usage_page, collection, usage, caps, caps_count, preparsed_data );
 547
 548     return enum_value_caps( preparsed, report_type, 0, &filter, get_button_caps, &caps, caps_count );
 549 }
 550
 551 static NTSTATUS get_value_caps( const struct hid_value_caps *caps, void *user )
 552 {
 553     HIDP_VALUE_CAPS **iter = user, *dst = *iter;
 554     dst->UsagePage = caps->usage_page;
 555     dst->ReportID = caps->report_id;
 556     dst->LinkCollection = caps->link_collection;
 557     dst->LinkUsagePage = caps->link_usage_page;
 558     dst->LinkUsage = caps->link_usage;
 559     dst->BitField = caps->bit_field;
 560     dst->IsAlias = FALSE;
 561     dst->IsAbsolute = HID_VALUE_CAPS_IS_ABSOLUTE( caps );
 562     dst->HasNull = HID_VALUE_CAPS_HAS_NULL( caps );
 563     dst->BitSize = caps->bit_size;
 564     dst->ReportCount = caps->is_range ? 1 : caps->report_count;
 565     dst->UnitsExp = caps->units_exp;
 566     dst->Units = caps->units;
 567     dst->LogicalMin = caps->logical_min;
 568     dst->LogicalMax = caps->logical_max;
 569     dst->PhysicalMin = caps->physical_min;
 570     dst->PhysicalMax = caps->physical_max;
 571     if (!(dst->IsRange = caps->is_range))
 572     {
 573         dst->NotRange.Usage = caps->usage_min;
 574         dst->NotRange.DataIndex = caps->data_index_min;
 575     }
 576     else
 577     {
 578         dst->Range.UsageMin = caps->usage_min;
 579         dst->Range.UsageMax = caps->usage_max;
 580         dst->Range.DataIndexMin = caps->data_index_min;
 581         dst->Range.DataIndexMax = caps->data_index_max;
 582     }
 583     if (!(dst->IsStringRange = caps->is_string_range))
 584         dst->NotRange.StringIndex = caps->string_min;
 585     else
 586     {
 587         dst->Range.StringMin = caps->string_min;
 588         dst->Range.StringMax = caps->string_max;
 589     }
 590     if ((dst->IsDesignatorRange = caps->is_designator_range))
 591         dst->NotRange.DesignatorIndex = caps->designator_min;
 592     else
 593     {
 594         dst->Range.DesignatorMin = caps->designator_min;
 595         dst->Range.DesignatorMax = caps->designator_max;
 596     }
 597     *iter += 1;
 598     return HIDP_STATUS_SUCCESS;
 599 }
 600
 601 NTSTATUS WINAPI HidP_GetSpecificValueCaps( HIDP_REPORT_TYPE report_type, USAGE usage_page, USHORT collection,
 602                                            USAGE usage, HIDP_VALUE_CAPS *caps, USHORT *caps_count,
 603                                            PHIDP_PREPARSED_DATA preparsed_data )
 604 {
 605     WINE_HIDP_PREPARSED_DATA *preparsed = (WINE_HIDP_PREPARSED_DATA *)preparsed_data;
 606     const struct caps_filter filter = {.values = TRUE, .usage_page = usage_page, .collection = collection, .usage = usage};
 607
 608     TRACE( "report_type %d, usage_page %x, collection %d, usage %x, caps %p, caps_count %p, preparsed_data %p.\n",
 609            report_type, usage_page, collection, usage, caps, caps_count, preparsed_data );
 610
 611     return enum_value_caps( preparsed, report_type, 0, &filter, get_value_caps, &caps, caps_count );
 612 }
 613
 614 struct get_usage_and_page_params
 615 {
 616     USAGE_AND_PAGE *usages;
 617     USAGE_AND_PAGE *usages_end;
 618     char *report_buf;
 619 };
 620
 621 static NTSTATUS get_usage_and_page( const struct hid_value_caps *caps, void *user )
 622 {
 623     struct get_usage_and_page_params *params = user;
 624     ULONG bit, last;
 625     BYTE index;
 626
 627     if (HID_VALUE_CAPS_IS_ARRAY( caps ))
 628     {
 629         for (bit = caps->start_bit, last = bit + caps->report_count * caps->bit_size - 1; bit <= last; bit += 8)
 630         {
 631             if (!(index = params->report_buf[bit / 8])) continue;
 632             if (params->usages < params->usages_end)
 633             {
 634                 params->usages->UsagePage = caps->usage_page;
 635                 params->usages->Usage = caps->usage_min + index - caps->start_index;
 636             }
 637             params->usages++;
 638         }
 639         return HIDP_STATUS_SUCCESS;
 640     }
 641
 642     for (bit = caps->start_bit, last = bit + caps->usage_max - caps->usage_min; bit <= last; bit++)
 643     {
 644         if (!(params->report_buf[bit / 8] & (1 << (bit % 8)))) continue;
 645         if (params->usages < params->usages_end)
 646         {
 647             params->usages->UsagePage = caps->usage_page;
 648             params->usages->Usage = caps->usage_min + bit - caps->start_bit;
 649         }
 650         params->usages++;
 651     }
 652
 653     return HIDP_STATUS_SUCCESS;
 654 }
 655
 656 NTSTATUS WINAPI HidP_GetUsagesEx( HIDP_REPORT_TYPE report_type, USHORT collection, USAGE_AND_PAGE *usages,
 657                                   ULONG *usages_len, PHIDP_PREPARSED_DATA preparsed_data, char *report_buf, ULONG report_len )
 658 {
 659     struct get_usage_and_page_params params = {.usages = usages, .usages_end = usages + *usages_len, .report_buf = report_buf};
 660     WINE_HIDP_PREPARSED_DATA *preparsed = (WINE_HIDP_PREPARSED_DATA *)preparsed_data;
 661     struct caps_filter filter = {.buttons = TRUE, .collection = collection};
 662     NTSTATUS status;
 663     USHORT limit = -1;
 664
 665     TRACE( "report_type %d, collection %d, usages %p, usages_len %p, preparsed_data %p, report_buf %p, report_len %u.\n",
 666            report_type, collection, usages, usages_len, preparsed_data, report_buf, report_len );
 667
 668     if (!report_len) return HIDP_STATUS_INVALID_REPORT_LENGTH;
 669
 670     filter.report_id = report_buf[0];
 671     status = enum_value_caps( preparsed, report_type, report_len, &filter, get_usage_and_page, &params, &limit );
 672     *usages_len = params.usages - usages;
 673     if (status != HIDP_STATUS_SUCCESS) return status;
 674
 675     if (*usages_len == 0) return HIDP_STATUS_USAGE_NOT_FOUND;
 676     if (params.usages > params.usages_end) return HIDP_STATUS_BUFFER_TOO_SMALL;
 677     return status;
 678 }
 679
 680 static NTSTATUS count_data( const struct hid_value_caps *caps, void *user )
 681 {
 682     if (caps->is_range || HID_VALUE_CAPS_IS_BUTTON( caps )) *(ULONG *)user += caps->report_count;
 683     else *(ULONG *)user += 1;
 684     return HIDP_STATUS_SUCCESS;
 685 }
 686
 687 ULONG WINAPI HidP_MaxDataListLength( HIDP_REPORT_TYPE report_type, PHIDP_PREPARSED_DATA preparsed_data )
 688 {
 689     WINE_HIDP_PREPARSED_DATA *preparsed = (WINE_HIDP_PREPARSED_DATA *)preparsed_data;
 690     struct caps_filter filter = {};
 691     USHORT limit = -1;
 692     ULONG count = 0;
 693
 694     TRACE( "report_type %d, preparsed_data %p.\n", report_type, preparsed_data );
 695
 696     enum_value_caps( preparsed, report_type, 0, &filter, count_data, &count, &limit );
 697     return count;
 698 }
 699
 700 struct find_all_data_params
 701 {
 702     HIDP_DATA *data;
 703     HIDP_DATA *data_end;
 704     char *report_buf;
 705 };
 706
 707 static NTSTATUS find_all_data( const struct hid_value_caps *caps, void *user )
 708 {
 709     struct find_all_data_params *params = user;
 710     HIDP_DATA *data = params->data, *data_end = params->data_end;
 711     ULONG bit, last, bit_count = caps->bit_size * caps->report_count;
 712     char *report_buf = params->report_buf;
 713     BYTE index;
 714
 715     if (!caps->bit_size) return HIDP_STATUS_SUCCESS;
 716
 717     if (HID_VALUE_CAPS_IS_ARRAY( caps ))
 718     {
 719         for (bit = caps->start_bit, last = bit + caps->report_count * caps->bit_size - 1; bit <= last; bit += 8)
 720         {
 721             if (!(index = report_buf[bit / 8])) continue;
 722             if (data < data_end)
 723             {
 724                 data->DataIndex = caps->data_index_min + index - caps->start_index;
 725                 data->On = 1;
 726             }
 727             data++;
 728         }
 729     }
 730     else if (HID_VALUE_CAPS_IS_BUTTON( caps ))
 731     {
 732         for (bit = caps->start_bit, last = bit + caps->usage_max - caps->usage_min; bit <= last; bit++)
 733         {
 734             if (!(report_buf[bit / 8] & (1 << (bit % 8)))) continue;
 735             if (data < data_end)
 736             {
 737                 data->DataIndex = caps->data_index_min + bit - caps->start_bit;
 738                 data->On = 1;
 739             }
 740             data++;
 741         }
 742     }
 743     else if (caps->report_count == 1)
 744     {
 745         if (data < data_end)
 746         {
 747             data->DataIndex = caps->data_index_min;
 748             data->RawValue = 0;
 749             if ((bit_count + 7) / 8 > sizeof(data->RawValue)) return HIDP_STATUS_BUFFER_TOO_SMALL;
 750             copy_bits( (void *)&data->RawValue, (void *)report_buf, bit_count, -caps->start_bit );
 751         }
 752         data++;
 753     }
 754
 755     params->data = data;
 756     return HIDP_STATUS_SUCCESS;
 757 }
 758
 759 NTSTATUS WINAPI HidP_GetData( HIDP_REPORT_TYPE report_type, HIDP_DATA *data, ULONG *data_len,
 760                               PHIDP_PREPARSED_DATA preparsed_data, char *report_buf, ULONG report_len )
 761 {
 762     struct find_all_data_params params = {.data = data, .data_end = data + *data_len, .report_buf = report_buf};
 763     WINE_HIDP_PREPARSED_DATA *preparsed = (WINE_HIDP_PREPARSED_DATA *)preparsed_data;
 764     struct caps_filter filter = {};
 765     NTSTATUS status;
 766     USHORT limit = -1;
 767
 768     TRACE( "report_type %d, data %p, data_len %p, preparsed_data %p, report_buf %p, report_len %u.\n",
 769            report_type, data, data_len, preparsed_data, report_buf, report_len );
 770
 771     if (!report_len) return HIDP_STATUS_INVALID_REPORT_LENGTH;
 772
 773     filter.report_id = report_buf[0];
 774     status = enum_value_caps( preparsed, report_type, report_len, &filter, find_all_data, &params, &limit );
 775     *data_len = params.data - data;
 776     if (status != HIDP_STATUS_SUCCESS) return status;
 777
 778     if (params.data > params.data_end) return HIDP_STATUS_BUFFER_TOO_SMALL;
 779     return HIDP_STATUS_SUCCESS;
 780 }
 781
 782 NTSTATUS WINAPI HidP_GetLinkCollectionNodes( HIDP_LINK_COLLECTION_NODE *nodes, ULONG *nodes_len, PHIDP_PREPARSED_DATA preparsed_data )
 783 {
 784     WINE_HIDP_PREPARSED_DATA *preparsed = (WINE_HIDP_PREPARSED_DATA *)preparsed_data;
 785     struct hid_value_caps *caps = HID_COLLECTION_VALUE_CAPS( preparsed );
 786     ULONG i, count, capacity = *nodes_len;
 787
 788     TRACE( "nodes %p, nodes_len %p, preparsed_data %p.\n", nodes, nodes_len, preparsed_data );
 789
 790     if (preparsed->magic != HID_MAGIC) return HIDP_STATUS_INVALID_PREPARSED_DATA;
 791
 792     count = *nodes_len = preparsed->caps.NumberLinkCollectionNodes;
 793     if (capacity < count) return HIDP_STATUS_BUFFER_TOO_SMALL;
 794
 795     for (i = 0; i < count; ++i)
 796     {
 797         nodes[i].LinkUsagePage = caps[i].usage_page;
 798         nodes[i].LinkUsage = caps[i].usage_min;
 799         nodes[i].Parent = caps[i].link_collection;
 800         nodes[i].CollectionType = caps[i].bit_field;
 801         nodes[i].IsAlias = 0;
 802         nodes[i].FirstChild = 0;
 803         nodes[i].NextSibling = 0;
 804         nodes[i].NumberOfChildren = 0;
 805
 806         if (i > 0)
 807         {
 808             nodes[i].NextSibling = nodes[nodes[i].Parent].FirstChild;
 809             nodes[nodes[i].Parent].FirstChild = i;
 810             nodes[nodes[i].Parent].NumberOfChildren++;
 811         }
 812     }
 813
 814     return HIDP_STATUS_SUCCESS;
 815 }