linux-imx

/* SPDX-License-Identifier: GPL-2.0+ */

/*

 *  HID driver for UC-Logic devices not fully compliant with HID standard

 *  - tablet initialization and parameter retrieval

 *

 *  Copyright (c) 2018 Nikolai Kondrashov

 */

​

/*

 * This program is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License as published by the Free

 * Software Foundation; either version 2 of the License, or (at your option)

 * any later version.

 */

​

#ifndef _HID_UCLOGIC_PARAMS_H

#define _HID_UCLOGIC_PARAMS_H

​

#include <linux/usb.h>

#include <linux/hid.h>

​

/* Types of pen in-range reporting */

enum uclogic_params_pen_inrange {

    /* Normal reports: zero - out of proximity, one - in proximity */

    UCLOGIC_PARAMS_PEN_INRANGE_NORMAL = 0,

    /* Inverted reports: zero - in proximity, one - out of proximity */

    UCLOGIC_PARAMS_PEN_INRANGE_INVERTED,

    /* No reports */

    UCLOGIC_PARAMS_PEN_INRANGE_NONE,

};

​

/* Convert a pen in-range reporting type to a string */

extern const char *uclogic_params_pen_inrange_to_str(

            enum uclogic_params_pen_inrange inrange);

​

/*

 * Tablet interface's pen input parameters.

 *

 * Must use declarative (descriptive) language, not imperative, to simplify

 * understanding and maintain consistency.

 *

 * Noop (preserving functionality) when filled with zeroes.

 */

struct uclogic_params_pen {

    /*

     * Pointer to report descriptor describing the inputs.

     * Allocated with kmalloc.

     */

    __u8 *desc_ptr;

    /*

     * Size of the report descriptor.

     * Only valid, if "desc_ptr" is not NULL.

     */

    unsigned int desc_size;

    /* Report ID, if reports should be tweaked, zero if not */

    unsigned int id;

    /* Type of in-range reporting, only valid if "id" is not zero */

    enum uclogic_params_pen_inrange inrange;

    /*

     * True, if reports include fragmented high resolution coords, with

     * high-order X and then Y bytes following the pressure field.

     * Only valid if "id" is not zero.

     */