libuuu/hidreport.h

   1 /*
   2 * Copyright 2018 NXP.
   3 *
   4 * Redistribution and use in source and binary forms, with or without modification,
   5 * are permitted provided that the following conditions are met:
   6 *
   7 * Redistributions of source code must retain the above copyright notice, this
   8 * list of conditions and the following disclaimer.
   9 *
  10 * Redistributions in binary form must reproduce the above copyright notice, this
  11 * list of conditions and the following disclaimer in the documentation and/or
  12 * other materials provided with the distribution.
  13 *
  14 * Neither the name of the NXP Semiconductor nor the names of its
  15 * contributors may be used to endorse or promote products derived from this
  16 * software without specific prior written permission.
  17 *
  18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  19 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
  22 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  23 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  24 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  25 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  26 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  27 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28 * POSSIBILITY OF SUCH DAMAGE.
  29 *
  30 */
  31 #pragma once
  32
  33 #include "libuuu.h"
  34
  35 #include <vector>
  36
  37 class TransBase;
  38
  39 class HIDReport
  40 {
  41 public:
  42         HIDReport(TransBase *trans) : m_pdev{trans}
  43         {
  44                 m_out_buff.resize(m_size_out + m_size_payload);
  45         }
  46         virtual ~HIDReport();
  47
  48         size_t get_out_package_size() noexcept { return m_size_out; }
  49         virtual void notify(size_t index, uuu_notify::NOTIFY_TYPE type);
  50         int read(std::vector<uint8_t> &buff);
  51         void set_notify_total(size_t notify_total) noexcept { m_notify_total = notify_total; }
  52         void set_out_package_size(size_t sz)
  53         {
  54                 m_size_out = sz;
  55                 m_out_buff.resize(m_size_out + m_size_payload);
  56         }
  57         void set_position_base(size_t position_base) noexcept { m_postion_base = position_base; }
  58         void set_skip_notify(bool skip_notify) noexcept { m_skip_notify = skip_notify; }
  59         int write(const void *p, size_t sz, uint8_t report_id);
  60         int write(const std::vector<uint8_t> &buff, uint8_t report_id)
  61         {
  62                 return write(buff.data(), buff.size(), report_id);
  63         }
  64
  65 private:
  66         size_t m_notify_total = 0;
  67         std::vector<uint8_t> m_out_buff;
  68         TransBase * const m_pdev = nullptr;
  69         size_t m_postion_base = 0;
  70         size_t m_size_in = 64;
  71         size_t m_size_out = 1024;
  72         size_t m_size_payload = 1;
  73         bool m_skip_notify = true;
  74 };