mirror of
https://github.com/jam422470459/EPD-nRF52-hema213.git
synced 2025-12-19 23:03:21 +08:00
move components to SDK dir
This commit is contained in:
Shuanglei Tao
@@ -0,0 +1,461 @@
|
||||
/**
|
||||
* Copyright (c) 2016 - 2017, Nordic Semiconductor ASA
|
||||
*
|
||||
* All rights reserved.
|
||||
*
|
||||
* Redistribution and use in source and binary forms, with or without modification,
|
||||
* are permitted provided that the following conditions are met:
|
||||
*
|
||||
* 1. Redistributions of source code must retain the above copyright notice, this
|
||||
* list of conditions and the following disclaimer.
|
||||
*
|
||||
* 2. Redistributions in binary form, except as embedded into a Nordic
|
||||
* Semiconductor ASA integrated circuit in a product or a software update for
|
||||
* such product, must reproduce the above copyright notice, this list of
|
||||
* conditions and the following disclaimer in the documentation and/or other
|
||||
* materials provided with the distribution.
|
||||
*
|
||||
* 3. Neither the name of Nordic Semiconductor ASA nor the names of its
|
||||
* contributors may be used to endorse or promote products derived from this
|
||||
* software without specific prior written permission.
|
||||
*
|
||||
* 4. This software, with or without modification, must only be used with a
|
||||
* Nordic Semiconductor ASA integrated circuit.
|
||||
*
|
||||
* 5. Any software provided in binary form under this license must not be reverse
|
||||
* engineered, decompiled, modified and/or disassembled.
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
|
||||
* OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
||||
* OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
* DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
|
||||
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
||||
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
|
||||
* GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
||||
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||||
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
|
||||
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
*
|
||||
*/
|
||||
#include "sdk_config.h"
|
||||
#if APP_USBD_HID_MOUSE_ENABLED
|
||||
#include <string.h>
|
||||
|
||||
#include "sdk_common.h"
|
||||
#include "app_usbd_hid_mouse.h"
|
||||
#include "app_util_platform.h"
|
||||
|
||||
|
||||
/**
|
||||
* @defgroup app_usbd_hid_mouse_internal USBD HID Mouse internals
|
||||
* @{
|
||||
* @ingroup app_usbd_hid_mouse
|
||||
* @internal
|
||||
*/
|
||||
|
||||
/**
|
||||
* @brief Auxiliary function to access HID mouse context data
|
||||
*
|
||||
* @param[in] p_inst class instance data
|
||||
* @return HID mouse instance data @ref app_usbd_hid_mouse_ctx_t
|
||||
*/
|
||||
static inline app_usbd_hid_mouse_ctx_t * hid_mouse_ctx_get(app_usbd_hid_mouse_t const * p_mouse)
|
||||
{
|
||||
ASSERT(p_mouse != NULL);
|
||||
ASSERT(p_mouse->specific.p_data != NULL);
|
||||
return &p_mouse->specific.p_data->ctx;
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Auxiliary function to access HID mouse instance data
|
||||
*
|
||||
* @param[in] p_inst class instance data
|
||||
* @return HID mouse instance data @ref app_usbd_hid_mouse_t
|
||||
*/
|
||||
static inline app_usbd_hid_mouse_t const * hid_mouse_get(app_usbd_class_inst_t const * p_inst)
|
||||
{
|
||||
ASSERT(p_inst != NULL);
|
||||
return (app_usbd_hid_mouse_t const *)p_inst;
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Returns mouse report buffer handle
|
||||
*
|
||||
* @param[in] p_kbd HID keyboard instance
|
||||
* @return HID report buffer @ref app_usbd_hid_report_buffer_t
|
||||
* */
|
||||
static inline
|
||||
app_usbd_hid_report_buffer_t const * hid_mouse_rep_buffer_get(app_usbd_hid_mouse_t const * p_mouse)
|
||||
{
|
||||
ASSERT(p_mouse != NULL);
|
||||
app_usbd_hid_inst_t const * p_hinst = &p_mouse->specific.inst.hid_inst;
|
||||
app_usbd_hid_mouse_ctx_t * p_mouse_ctx = hid_mouse_ctx_get(p_mouse);
|
||||
app_usbd_hid_report_buffer_t * p_rep_buff = app_usbd_hid_rep_buff_in_get(p_hinst, 0);
|
||||
|
||||
p_rep_buff->p_buff = p_mouse_ctx->report_buff;
|
||||
p_rep_buff->size = sizeof(p_mouse_ctx->report_buff);
|
||||
|
||||
/*Mouse has only one report input report buffer */
|
||||
return app_usbd_hid_rep_buff_in_get(p_hinst, 0);
|
||||
}
|
||||
|
||||
/**@brief Auxiliary function to get report value from internal accumulated value
|
||||
*
|
||||
* @param[in] acc accumulated XY axis or scroll
|
||||
* @return Offset value that could be written directly to report buffer
|
||||
*/
|
||||
static inline int8_t hid_mouse_axis_acc_get(int16_t acc)
|
||||
{
|
||||
if (acc > INT8_MAX)
|
||||
{
|
||||
return INT8_MAX;
|
||||
}
|
||||
|
||||
if (acc < INT8_MIN)
|
||||
{
|
||||
return INT8_MIN;
|
||||
}
|
||||
|
||||
return acc;
|
||||
}
|
||||
|
||||
/**@brief Auxiliary function to prepare report transfer buffer to next transfer
|
||||
*
|
||||
* @param[in] p_mouse_ctx mouse internal context
|
||||
* @retval true if next transfer is required
|
||||
* @retval false if next transfer is not required
|
||||
*/
|
||||
static inline bool hid_mouse_transfer_next(app_usbd_hid_mouse_t const * p_mouse)
|
||||
{
|
||||
|
||||
app_usbd_hid_mouse_ctx_t * p_mouse_ctx = hid_mouse_ctx_get(p_mouse);
|
||||
app_usbd_hid_report_buffer_t const * p_rep_buffer = hid_mouse_rep_buffer_get(p_mouse);
|
||||
|
||||
uint8_t * p_buff = p_rep_buffer->p_buff;
|
||||
|
||||
/*Save last buttons state*/
|
||||
uint8_t last_button_state = p_buff[0];
|
||||
|
||||
/*Button state*/
|
||||
p_buff[0] = p_mouse_ctx->button_state;
|
||||
|
||||
/*Axis X*/
|
||||
int8_t val_x = hid_mouse_axis_acc_get(p_mouse_ctx->acc_x_axis);
|
||||
p_mouse_ctx->acc_x_axis -= val_x;
|
||||
p_buff[1] = val_x;
|
||||
|
||||
/*Axis Y*/
|
||||
int8_t val_y = hid_mouse_axis_acc_get(p_mouse_ctx->acc_y_axis);
|
||||
p_mouse_ctx->acc_y_axis -= val_y;
|
||||
p_buff[2] = val_y;
|
||||
|
||||
/*Scroll*/
|
||||
int8_t val_scroll = hid_mouse_axis_acc_get(p_mouse_ctx->acc_scroll);
|
||||
p_mouse_ctx->acc_scroll -= val_scroll;
|
||||
p_buff[3] = val_scroll;
|
||||
|
||||
if (val_x || val_y || val_scroll)
|
||||
{
|
||||
/*New transfer is required if any of mouse relative position is not zero*/
|
||||
return true;
|
||||
}
|
||||
|
||||
if (last_button_state != p_buff[0])
|
||||
{
|
||||
/*New transfer is required if button state has changed*/
|
||||
return true;
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Triggers IN endpoint transfer
|
||||
*
|
||||
* @param[in] p_mouse HID mouse instance
|
||||
* @return standard error code
|
||||
*/
|
||||
static inline ret_code_t hid_mouse_transfer_set(app_usbd_hid_mouse_t const * p_mouse)
|
||||
{
|
||||
app_usbd_class_inst_t const * p_inst = (app_usbd_class_inst_t const *)p_mouse;
|
||||
app_usbd_hid_mouse_ctx_t * p_mouse_ctx = hid_mouse_ctx_get(p_mouse);
|
||||
|
||||
nrf_drv_usbd_ep_t ep_addr = app_usbd_hid_epin_addr_get(p_inst);
|
||||
|
||||
app_usbd_hid_state_flag_clr(&p_mouse_ctx->hid_ctx, APP_USBD_HID_STATE_FLAG_TRANS_IN_PROGRESS);
|
||||
if (!hid_mouse_transfer_next(p_mouse))
|
||||
{
|
||||
/* Transfer buffer hasn't changed since last transfer. No need to setup
|
||||
* next transfer.
|
||||
* */
|
||||
return NRF_SUCCESS;
|
||||
}
|
||||
|
||||
app_usbd_hid_report_buffer_t const * p_rep_buffer = hid_mouse_rep_buffer_get(p_mouse);
|
||||
|
||||
NRF_DRV_USBD_TRANSFER_IN(transfer, p_rep_buffer->p_buff, p_rep_buffer->size);
|
||||
|
||||
ret_code_t ret;
|
||||
CRITICAL_REGION_ENTER();
|
||||
ret = app_usbd_core_ep_transfer(ep_addr, &transfer, NULL);
|
||||
if (ret == NRF_SUCCESS)
|
||||
{
|
||||
app_usbd_hid_state_flag_set(&p_mouse_ctx->hid_ctx,
|
||||
APP_USBD_HID_STATE_FLAG_TRANS_IN_PROGRESS);
|
||||
}
|
||||
CRITICAL_REGION_EXIT();
|
||||
|
||||
return ret;
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Checks if adding would cause 16 bit signed integer overflow
|
||||
*
|
||||
* @param[in] signed 16 bit accumulator to test
|
||||
* @param[in] value value to add to accumulator
|
||||
* @return true if overflow detected, false otherwise
|
||||
*/
|
||||
static inline bool hid_mouse_acc_overflow_check(int16_t acc, int8_t val)
|
||||
{
|
||||
if (((int32_t)acc + val) > INT16_MAX)
|
||||
{
|
||||
return true;
|
||||
}
|
||||
|
||||
if (((int32_t)acc + val) < INT16_MIN)
|
||||
{
|
||||
return true;
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
ret_code_t app_usbd_hid_mouse_x_move(app_usbd_hid_mouse_t const * p_mouse, int8_t offset)
|
||||
{
|
||||
app_usbd_hid_mouse_ctx_t * p_mouse_ctx = hid_mouse_ctx_get(p_mouse);
|
||||
if (!app_usbd_hid_state_valid(&p_mouse_ctx->hid_ctx))
|
||||
{
|
||||
return NRF_ERROR_INVALID_STATE;
|
||||
}
|
||||
|
||||
if (offset == 0)
|
||||
{
|
||||
/*No position change*/
|
||||
return NRF_SUCCESS;
|
||||
}
|
||||
|
||||
if (hid_mouse_acc_overflow_check(p_mouse_ctx->acc_y_axis, offset))
|
||||
{
|
||||
/*Overflow detected*/
|
||||
return NRF_ERROR_BUSY;
|
||||
}
|
||||
|
||||
app_usbd_hid_access_lock(&p_mouse_ctx->hid_ctx);
|
||||
p_mouse_ctx->acc_x_axis += offset;
|
||||
app_usbd_hid_access_unlock(&p_mouse_ctx->hid_ctx);
|
||||
|
||||
if (app_usbd_hid_trans_required(&p_mouse_ctx->hid_ctx))
|
||||
{
|
||||
/*New transfer need to be triggered*/
|
||||
return hid_mouse_transfer_set(p_mouse);
|
||||
}
|
||||
|
||||
return NRF_SUCCESS;
|
||||
}
|
||||
|
||||
ret_code_t app_usbd_hid_mouse_y_move(app_usbd_hid_mouse_t const * p_mouse, int8_t offset)
|
||||
{
|
||||
app_usbd_hid_mouse_ctx_t * p_mouse_ctx = hid_mouse_ctx_get(p_mouse);
|
||||
|
||||
if (offset == 0)
|
||||
{
|
||||
/*No position change*/
|
||||
return NRF_SUCCESS;
|
||||
}
|
||||
|
||||
if (hid_mouse_acc_overflow_check(p_mouse_ctx->acc_y_axis, offset))
|
||||
{
|
||||
/*Overflow detected*/
|
||||
return NRF_ERROR_BUSY;
|
||||
}
|
||||
|
||||
app_usbd_hid_access_lock(&p_mouse_ctx->hid_ctx);
|
||||
p_mouse_ctx->acc_y_axis += offset;
|
||||
app_usbd_hid_access_unlock(&p_mouse_ctx->hid_ctx);
|
||||
|
||||
if (app_usbd_hid_trans_required(&p_mouse_ctx->hid_ctx))
|
||||
{
|
||||
/*New transfer need to be triggered*/
|
||||
return hid_mouse_transfer_set(p_mouse);
|
||||
}
|
||||
|
||||
return NRF_SUCCESS;
|
||||
}
|
||||
|
||||
ret_code_t app_usbd_hid_mouse_scroll_move(app_usbd_hid_mouse_t const * p_mouse, int8_t offset)
|
||||
{
|
||||
app_usbd_hid_mouse_ctx_t * p_mouse_ctx = hid_mouse_ctx_get(p_mouse);
|
||||
if (!app_usbd_hid_state_valid(&p_mouse_ctx->hid_ctx))
|
||||
{
|
||||
return NRF_ERROR_INVALID_STATE;
|
||||
}
|
||||
|
||||
if (offset == 0)
|
||||
{
|
||||
/*No position change*/
|
||||
return NRF_SUCCESS;
|
||||
}
|
||||
|
||||
if (hid_mouse_acc_overflow_check(p_mouse_ctx->acc_scroll, offset))
|
||||
{
|
||||
/*Overflow detected*/
|
||||
return NRF_ERROR_BUSY;
|
||||
}
|
||||
|
||||
app_usbd_hid_access_lock(&p_mouse_ctx->hid_ctx);
|
||||
p_mouse_ctx->acc_scroll += offset;
|
||||
app_usbd_hid_access_unlock(&p_mouse_ctx->hid_ctx);
|
||||
|
||||
if (app_usbd_hid_trans_required(&p_mouse_ctx->hid_ctx))
|
||||
{
|
||||
/*New transfer need to be triggered*/
|
||||
return hid_mouse_transfer_set(p_mouse);
|
||||
}
|
||||
|
||||
return NRF_SUCCESS;
|
||||
}
|
||||
|
||||
ret_code_t app_usbd_hid_mouse_button_state(app_usbd_hid_mouse_t const * p_mouse,
|
||||
uint8_t button_id,
|
||||
bool state)
|
||||
{
|
||||
ASSERT(button_id < 8);
|
||||
app_usbd_hid_mouse_ctx_t * p_mouse_ctx = hid_mouse_ctx_get(p_mouse);
|
||||
|
||||
if (button_id >= p_mouse->specific.inst.button_count)
|
||||
{
|
||||
return NRF_ERROR_INVALID_PARAM;
|
||||
}
|
||||
|
||||
if (!app_usbd_hid_state_valid(&p_mouse_ctx->hid_ctx))
|
||||
{
|
||||
return NRF_ERROR_INVALID_STATE;
|
||||
}
|
||||
|
||||
if (IS_SET(p_mouse_ctx->button_state, button_id) == (state ? 1 : 0))
|
||||
{
|
||||
return NRF_SUCCESS;
|
||||
}
|
||||
|
||||
app_usbd_hid_access_lock(&p_mouse_ctx->hid_ctx);
|
||||
if (state)
|
||||
{
|
||||
SET_BIT(p_mouse_ctx->button_state, button_id);
|
||||
}
|
||||
else
|
||||
{
|
||||
CLR_BIT(p_mouse_ctx->button_state, button_id);
|
||||
}
|
||||
app_usbd_hid_access_unlock(&p_mouse_ctx->hid_ctx);
|
||||
|
||||
if (app_usbd_hid_trans_required(&p_mouse_ctx->hid_ctx))
|
||||
{
|
||||
/*New transfer need to be triggered*/
|
||||
return hid_mouse_transfer_set(p_mouse);
|
||||
}
|
||||
|
||||
return NRF_SUCCESS;
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief @ref app_usbd_hid_interface_t::on_get_report
|
||||
*/
|
||||
static ret_code_t hid_mouse_on_get_report(app_usbd_class_inst_t const * p_inst,
|
||||
app_usbd_setup_evt_t const * p_setup_ev)
|
||||
{
|
||||
app_usbd_hid_mouse_t const * p_mouse = hid_mouse_get(p_inst);
|
||||
app_usbd_hid_report_buffer_t const * p_rep_buffer = hid_mouse_rep_buffer_get(p_mouse);
|
||||
|
||||
return app_usbd_core_setup_rsp(&(p_setup_ev->setup), p_rep_buffer->p_buff, p_rep_buffer->size);
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief @ref app_usbd_hid_interface_t::on_set_report
|
||||
*/
|
||||
static ret_code_t hid_mouse_on_set_report(app_usbd_class_inst_t const * p_inst,
|
||||
app_usbd_setup_evt_t const * p_setup_ev)
|
||||
{
|
||||
return NRF_ERROR_NOT_SUPPORTED;
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief @ref app_usbd_hid_interface_t::ep_transfer_set
|
||||
*/
|
||||
static ret_code_t hid_mouse_ep_transfer_in(app_usbd_class_inst_t const * p_inst)
|
||||
{
|
||||
return hid_mouse_transfer_set((app_usbd_hid_mouse_t const *)p_inst);
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief @ref app_usbd_class_interface_t::event_handler
|
||||
*/
|
||||
static ret_code_t hid_mouse_event_handler(app_usbd_class_inst_t const * p_inst,
|
||||
app_usbd_complex_evt_t const * p_event)
|
||||
{
|
||||
ASSERT(p_inst != NULL);
|
||||
ASSERT(p_event != NULL);
|
||||
|
||||
app_usbd_hid_mouse_t const * p_mouse = hid_mouse_get(p_inst);
|
||||
app_usbd_hid_inst_t const * p_hinst = &p_mouse->specific.inst.hid_inst;
|
||||
|
||||
app_usbd_hid_mouse_ctx_t * p_mouse_ctx = hid_mouse_ctx_get(p_mouse);
|
||||
app_usbd_hid_ctx_t * p_hid_ctx = &p_mouse_ctx->hid_ctx;
|
||||
|
||||
|
||||
ret_code_t ret = NRF_SUCCESS;
|
||||
switch (p_event->app_evt.type)
|
||||
{
|
||||
default:
|
||||
ret = NRF_ERROR_NOT_SUPPORTED;
|
||||
break;
|
||||
}
|
||||
|
||||
if (ret != NRF_ERROR_NOT_SUPPORTED)
|
||||
{
|
||||
/* Event was processed by specific handler */
|
||||
return ret;
|
||||
}
|
||||
|
||||
/*Try handle event by generic HID event handler*/
|
||||
return app_usbd_hid_event_handler(p_inst, p_hinst, p_hid_ctx, p_event);
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief @ref app_usbd_class_interface_t::get_descriptors
|
||||
*/
|
||||
static const void * hid_mouse_get_descriptors(app_usbd_class_inst_t const * p_inst,
|
||||
size_t * p_size)
|
||||
{
|
||||
ASSERT(p_size != NULL);
|
||||
app_usbd_hid_mouse_t const * p_mouse = hid_mouse_get(p_inst);
|
||||
app_usbd_hid_inst_t const * p_hinst = &p_mouse->specific.inst.hid_inst;
|
||||
|
||||
*p_size = p_hinst->raw_desc_size;
|
||||
return p_hinst->p_raw_desc;
|
||||
}
|
||||
|
||||
/** @} */
|
||||
|
||||
const app_usbd_hid_methods_t app_usbd_hid_mouse_methods = {
|
||||
.on_get_report = hid_mouse_on_get_report,
|
||||
.on_set_report = hid_mouse_on_set_report,
|
||||
.ep_transfer_in = hid_mouse_ep_transfer_in,
|
||||
.ep_transfer_out = NULL,
|
||||
};
|
||||
|
||||
const app_usbd_class_methods_t app_usbd_hid_mouse_class_methods = {
|
||||
.event_handler = hid_mouse_event_handler,
|
||||
.get_descriptors = hid_mouse_get_descriptors,
|
||||
};
|
||||
|
||||
#endif // APP_USBD_HID_MOUSE_ENABLED
|
||||
@@ -0,0 +1,179 @@
|
||||
/**
|
||||
* Copyright (c) 2016 - 2017, Nordic Semiconductor ASA
|
||||
*
|
||||
* All rights reserved.
|
||||
*
|
||||
* Redistribution and use in source and binary forms, with or without modification,
|
||||
* are permitted provided that the following conditions are met:
|
||||
*
|
||||
* 1. Redistributions of source code must retain the above copyright notice, this
|
||||
* list of conditions and the following disclaimer.
|
||||
*
|
||||
* 2. Redistributions in binary form, except as embedded into a Nordic
|
||||
* Semiconductor ASA integrated circuit in a product or a software update for
|
||||
* such product, must reproduce the above copyright notice, this list of
|
||||
* conditions and the following disclaimer in the documentation and/or other
|
||||
* materials provided with the distribution.
|
||||
*
|
||||
* 3. Neither the name of Nordic Semiconductor ASA nor the names of its
|
||||
* contributors may be used to endorse or promote products derived from this
|
||||
* software without specific prior written permission.
|
||||
*
|
||||
* 4. This software, with or without modification, must only be used with a
|
||||
* Nordic Semiconductor ASA integrated circuit.
|
||||
*
|
||||
* 5. Any software provided in binary form under this license must not be reverse
|
||||
* engineered, decompiled, modified and/or disassembled.
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
|
||||
* OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
||||
* OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
* DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
|
||||
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
||||
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
|
||||
* GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
||||
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||||
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
|
||||
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
*
|
||||
*/
|
||||
|
||||
#ifndef APP_USBD_HID_MOUSE_H__
|
||||
#define APP_USBD_HID_MOUSE_H__
|
||||
|
||||
#include <stdint.h>
|
||||
#include <stdbool.h>
|
||||
|
||||
#include "nrf_drv_usbd.h"
|
||||
#include "app_usbd_class_base.h"
|
||||
#include "app_usbd_hid_types.h"
|
||||
#include "app_usbd_hid.h"
|
||||
#include "app_usbd.h"
|
||||
#include "app_usbd_core.h"
|
||||
#include "app_usbd_descriptor.h"
|
||||
#include "app_usbd_hid_mouse_desc.h"
|
||||
#include "app_usbd_hid_mouse_internal.h"
|
||||
|
||||
/**
|
||||
* @defgroup app_usbd_hid_mouse USB HID mouse
|
||||
* @ingroup app_usbd_hid
|
||||
*
|
||||
* @brief @tagAPI52840 Module with types, definitions, and API used by the HID mouse class.
|
||||
* @{
|
||||
*/
|
||||
|
||||
#ifdef DOXYGEN
|
||||
/**
|
||||
* @brief HID mouse class instance type
|
||||
*
|
||||
* @ref APP_USBD_CLASS_TYPEDEF
|
||||
*/
|
||||
typedef struct { } app_usbd_hid_mouse_t;
|
||||
#else
|
||||
/*lint -save -e10 -e26 -e123 -e505 */
|
||||
APP_USBD_CLASS_TYPEDEF(app_usbd_hid_mouse, \
|
||||
APP_USBD_HID_MOUSE_CONFIG(0, NRF_DRV_USBD_EPIN1), \
|
||||
APP_USBD_HID_MOUSE_INSTANCE_SPECIFIC_DEC, \
|
||||
APP_USBD_HID_MOUSE_DATA_SPECIFIC_DEC \
|
||||
);
|
||||
/*lint -restore*/
|
||||
#endif
|
||||
/**
|
||||
* @brief Global definition of app_usbd_hid_mouse_t class
|
||||
*
|
||||
* @param instance_name Name of global instance
|
||||
* @param interface_number Unique interface number
|
||||
* @param endpoint Input endpoint (@ref nrf_drv_usbd_ep_t)
|
||||
* @param bcnt Mouse button count (from 1 to 8)
|
||||
* @param user_ev_handler User event handler (optional)
|
||||
*
|
||||
* @note This macro is just simplified version of @ref APP_USBD_HID_MOUSE_GLOBAL_DEF_INTERNAL.
|
||||
*
|
||||
* @code
|
||||
APP_USBD_HID_MOUSE_GLOBAL_DEF(my_awesome_mouse, 0, NRF_DRV_USBD_EPIN1, 3, NULL)
|
||||
* @endcode
|
||||
*/
|
||||
#define APP_USBD_HID_MOUSE_GLOBAL_DEF(instance_name, \
|
||||
interface_number, \
|
||||
endpoint, \
|
||||
bcnt, \
|
||||
user_ev_handler) \
|
||||
APP_USBD_HID_MOUSE_GLOBAL_DEF_INTERNAL(instance_name, \
|
||||
interface_number, \
|
||||
endpoint, \
|
||||
bcnt, \
|
||||
user_ev_handler)
|
||||
|
||||
|
||||
/**
|
||||
* @brief Helper function to get class instance from HID mouse internals
|
||||
*
|
||||
* @param[in] p_mouse Mouse instance (declared by @ref APP_USBD_HID_MOUSE_GLOBAL_DEF)
|
||||
*
|
||||
* @return Base class instance
|
||||
* */
|
||||
static inline app_usbd_class_inst_t const *
|
||||
app_usbd_hid_mouse_class_inst_get(app_usbd_hid_mouse_t const * p_mouse)
|
||||
{
|
||||
return &p_mouse->base;
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Helper function to get HID mouse from base class instance
|
||||
*
|
||||
* @param[in] p_inst Base class instance
|
||||
*
|
||||
* @return HID mouse class handle
|
||||
*/
|
||||
static inline app_usbd_hid_mouse_t const *
|
||||
app_usbd_hid_mouse_class_get(app_usbd_class_inst_t const * p_inst)
|
||||
{
|
||||
return (app_usbd_hid_mouse_t const *)p_inst;
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Move mouse X axis
|
||||
*
|
||||
* @param[in] p_mouse Mouse instance (declared by @ref APP_USBD_HID_MOUSE_GLOBAL_DEF)
|
||||
* @param[in] offset Relative mouse position: allowed full int8_t range
|
||||
*
|
||||
* @return Standard error code
|
||||
* */
|
||||
ret_code_t app_usbd_hid_mouse_x_move(app_usbd_hid_mouse_t const * p_mouse, int8_t offset);
|
||||
|
||||
/**
|
||||
* @brief Move mouse Y axis
|
||||
*
|
||||
* @param[in] p_mouse Mouse instance (declared by @ref APP_USBD_HID_MOUSE_GLOBAL_DEF)
|
||||
* @param[in] offset Relative mouse position: allowed full int8_t range
|
||||
*
|
||||
* @return Standard error code
|
||||
* */
|
||||
ret_code_t app_usbd_hid_mouse_y_move(app_usbd_hid_mouse_t const * p_mouse, int8_t offset);
|
||||
|
||||
/**
|
||||
* @brief Move mouse scroll
|
||||
*
|
||||
* @param[in] p_mouse Mouse instance (declared by @ref APP_USBD_HID_MOUSE_GLOBAL_DEF)
|
||||
* @param[in] offset Relative mouse position: allowed full int8_t range
|
||||
*
|
||||
* @return Standard error code
|
||||
* */
|
||||
ret_code_t app_usbd_hid_mouse_scroll_move(app_usbd_hid_mouse_t const * p_mouse, int8_t offset);
|
||||
|
||||
/**
|
||||
* @brief Set mouse button state
|
||||
*
|
||||
* @param[in] p_mouse Mouse instance (declared by @ref APP_USBD_HID_MOUSE_GLOBAL_DEF)
|
||||
* @param[in] button_id Button number (0...7)
|
||||
* @param[in] state Button state: true -> PRESSED, false -> RELEASED
|
||||
*
|
||||
* @return Standard error code
|
||||
* */
|
||||
ret_code_t app_usbd_hid_mouse_button_state(app_usbd_hid_mouse_t const * p_mouse,
|
||||
uint8_t button_id,
|
||||
bool state);
|
||||
|
||||
/** @} */
|
||||
|
||||
#endif /* APP_USBD_HID_MOUSE_H__ */
|
||||
@@ -0,0 +1,119 @@
|
||||
/**
|
||||
* Copyright (c) 2016 - 2017, Nordic Semiconductor ASA
|
||||
*
|
||||
* All rights reserved.
|
||||
*
|
||||
* Redistribution and use in source and binary forms, with or without modification,
|
||||
* are permitted provided that the following conditions are met:
|
||||
*
|
||||
* 1. Redistributions of source code must retain the above copyright notice, this
|
||||
* list of conditions and the following disclaimer.
|
||||
*
|
||||
* 2. Redistributions in binary form, except as embedded into a Nordic
|
||||
* Semiconductor ASA integrated circuit in a product or a software update for
|
||||
* such product, must reproduce the above copyright notice, this list of
|
||||
* conditions and the following disclaimer in the documentation and/or other
|
||||
* materials provided with the distribution.
|
||||
*
|
||||
* 3. Neither the name of Nordic Semiconductor ASA nor the names of its
|
||||
* contributors may be used to endorse or promote products derived from this
|
||||
* software without specific prior written permission.
|
||||
*
|
||||
* 4. This software, with or without modification, must only be used with a
|
||||
* Nordic Semiconductor ASA integrated circuit.
|
||||
*
|
||||
* 5. Any software provided in binary form under this license must not be reverse
|
||||
* engineered, decompiled, modified and/or disassembled.
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
|
||||
* OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
||||
* OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
* DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
|
||||
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
||||
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
|
||||
* GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
||||
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||||
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
|
||||
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
*
|
||||
*/
|
||||
|
||||
#ifndef APP_USBD_HID_MOUSE_DESC_H__
|
||||
#define APP_USBD_HID_MOUSE_DESC_H__
|
||||
|
||||
/**
|
||||
* @defgroup app_usbd_hid_mouse_desc USB HID mouse descriptors
|
||||
* @ingroup app_usbd_hid_mouse
|
||||
*
|
||||
* @brief @tagAPI52840 Module with types, definitions, and API used by the HID mouse class.
|
||||
* @{
|
||||
*/
|
||||
|
||||
/**
|
||||
* @brief Initializer of interface descriptor for HID mouse class
|
||||
*
|
||||
* @param interface_number Interface number
|
||||
* */
|
||||
#define APP_USBD_HID_MOUSE_INTERFACE_DSC(interface_number) \
|
||||
APP_USBD_HID_INTERFACE_DSC(interface_number, \
|
||||
1, \
|
||||
APP_USBD_HID_SUBCLASS_BOOT, \
|
||||
APP_USBD_HID_PROTO_MOUSE)
|
||||
|
||||
/**
|
||||
* @brief Initializer of HID descriptor for HID mouse class
|
||||
*
|
||||
* @param ... Descriptor list
|
||||
* */
|
||||
#define APP_USBD_HID_MOUSE_HID_DSC(...) \
|
||||
APP_USBD_HID_HID_DSC(__VA_ARGS__)
|
||||
|
||||
/**
|
||||
* @brief Initializer of endpoint descriptor for HID mouse class
|
||||
*
|
||||
* @param endpoint_number Endpoint number
|
||||
* */
|
||||
#define APP_USBD_HID_MOUSE_EP_DSC(endpoint_number) \
|
||||
APP_USBD_HID_EP_DSC(endpoint_number, 8, 1)
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* @brief Example of USB HID mouse report descriptor for n button mouse
|
||||
*
|
||||
* @param bcnt Button count, allowed values from 1 to 8
|
||||
*
|
||||
* */
|
||||
#define APP_USBD_HID_MOUSE_REPORT_DSC_BUTTON(bcnt) { \
|
||||
0x05, 0x01, /* Usage Page (Generic Desktop), */ \
|
||||
0x09, 0x02, /* Usage (Mouse), */ \
|
||||
0xA1, 0x01, /* Collection (Application), */ \
|
||||
0x09, 0x01, /* Usage (Pointer), */ \
|
||||
0xA1, 0x00, /* Collection (Physical), */ \
|
||||
0x05, 0x09, /* Usage Page (Buttons), */ \
|
||||
0x19, 0x01, /* Usage Minimum (01), */ \
|
||||
0x29, bcnt, /* Usage Maximum (bcnt), */ \
|
||||
0x15, 0x00, /* Logical Minimum (0), */ \
|
||||
0x25, 0x01, /* Logical Maximum (1), */ \
|
||||
0x75, 0x01, /* Report Size (1), */ \
|
||||
0x95, bcnt, /* Report Count (bcnt), */ \
|
||||
0x81, 0x02, /* Input (Data, Variable, Absolute)*/ \
|
||||
0x75, (8-(bcnt)), /* Report Size (8-(bcnt)), */ \
|
||||
0x95, 0x01, /* Report Count (1), */ \
|
||||
0x81, 0x01, /* Input (Constant), */ \
|
||||
0x05, 0x01, /* Usage Page (Generic Desktop), */ \
|
||||
0x09, 0x30, /* Usage (X), */ \
|
||||
0x09, 0x31, /* Usage (Y), */ \
|
||||
0x09, 0x38, /* Usage (Scroll), */ \
|
||||
0x15, 0x81, /* Logical Minimum (-127), */ \
|
||||
0x25, 0x7F, /* Logical Maximum (127), */ \
|
||||
0x75, 0x08, /* Report Size (8), */ \
|
||||
0x95, 0x03, /* Report Count (3), */ \
|
||||
0x81, 0x06, /* Input (Data, Variable, Relative)*/ \
|
||||
0xC0, /* End Collection, */ \
|
||||
0xC0, /* End Collection */ \
|
||||
}
|
||||
|
||||
/** @} */
|
||||
|
||||
#endif /* APP_USBD_HID_MOUSE_DESC_H__ */
|
||||
@@ -0,0 +1,186 @@
|
||||
/**
|
||||
* Copyright (c) 2016 - 2017, Nordic Semiconductor ASA
|
||||
*
|
||||
* All rights reserved.
|
||||
*
|
||||
* Redistribution and use in source and binary forms, with or without modification,
|
||||
* are permitted provided that the following conditions are met:
|
||||
*
|
||||
* 1. Redistributions of source code must retain the above copyright notice, this
|
||||
* list of conditions and the following disclaimer.
|
||||
*
|
||||
* 2. Redistributions in binary form, except as embedded into a Nordic
|
||||
* Semiconductor ASA integrated circuit in a product or a software update for
|
||||
* such product, must reproduce the above copyright notice, this list of
|
||||
* conditions and the following disclaimer in the documentation and/or other
|
||||
* materials provided with the distribution.
|
||||
*
|
||||
* 3. Neither the name of Nordic Semiconductor ASA nor the names of its
|
||||
* contributors may be used to endorse or promote products derived from this
|
||||
* software without specific prior written permission.
|
||||
*
|
||||
* 4. This software, with or without modification, must only be used with a
|
||||
* Nordic Semiconductor ASA integrated circuit.
|
||||
*
|
||||
* 5. Any software provided in binary form under this license must not be reverse
|
||||
* engineered, decompiled, modified and/or disassembled.
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
|
||||
* OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
||||
* OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
* DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
|
||||
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
||||
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
|
||||
* GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
||||
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||||
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
|
||||
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
*
|
||||
*/
|
||||
|
||||
#ifndef APP_USBD_HID_MOUSE_INTERNAL_H__
|
||||
#define APP_USBD_HID_MOUSE_INTERNAL_H__
|
||||
|
||||
/**
|
||||
* @defgroup app_usbd_hid_mouse_internals USB HID mouse internals
|
||||
* @ingroup app_usbd_hid_mouse
|
||||
*
|
||||
* @brief @tagAPI52840 Module with types, definitions, and API used by the HID mouse class.
|
||||
* @{
|
||||
*/
|
||||
|
||||
/**
|
||||
* @brief Forward declaration of HID mouse class type
|
||||
*
|
||||
*/
|
||||
APP_USBD_CLASS_FORWARD(app_usbd_hid_mouse);
|
||||
|
||||
|
||||
/**
|
||||
* @brief HID mouse part of class instance data
|
||||
*
|
||||
*/
|
||||
typedef struct {
|
||||
app_usbd_hid_inst_t hid_inst; //!< HID instance data
|
||||
const uint8_t button_count; //!< Number of buttons mouse specific
|
||||
} app_usbd_hid_mouse_inst_t;
|
||||
|
||||
/**
|
||||
* @brief HID mouse context
|
||||
*
|
||||
* */
|
||||
typedef struct {
|
||||
app_usbd_hid_ctx_t hid_ctx; //!< HID class context
|
||||
|
||||
int16_t acc_x_axis; //!< Mouse specific. Accumulated x axis offset
|
||||
int16_t acc_y_axis; //!< Mouse specific. Accumulated y axis offset
|
||||
int16_t acc_scroll; //!< Mouse specific. Accumulated scroll offset
|
||||
uint8_t button_state; //!< Mouse specific. Actual button state. Bitfield of maximum 8 buttons states.
|
||||
uint8_t report_buff[4];
|
||||
} app_usbd_hid_mouse_ctx_t;
|
||||
|
||||
|
||||
/**
|
||||
* @brief HID mouse configuration macro
|
||||
*
|
||||
* Used by @ref APP_USBD_HID_MOUSE_GLOBAL_DEF
|
||||
*
|
||||
* */
|
||||
#define APP_USBD_HID_MOUSE_CONFIG(iface, ep) ((iface, ep))
|
||||
|
||||
|
||||
/**
|
||||
* @brief Specific class constant data for HID mouse class
|
||||
* */
|
||||
#define APP_USBD_HID_MOUSE_INSTANCE_SPECIFIC_DEC app_usbd_hid_mouse_inst_t inst;
|
||||
|
||||
/**
|
||||
* @brief Specific class data for HID mouse class
|
||||
* */
|
||||
#define APP_USBD_HID_MOUSE_DATA_SPECIFIC_DEC app_usbd_hid_mouse_ctx_t ctx;
|
||||
|
||||
|
||||
/**
|
||||
* @brief HID mouse descriptors config macro
|
||||
*
|
||||
* @ref app_usbd_hid_mouse_inst_t
|
||||
*
|
||||
* */
|
||||
#define APP_USBD_HID_MOUSE_DSC_CONFIG(interface_number, endpoint, rep_desc) { \
|
||||
APP_USBD_HID_MOUSE_INTERFACE_DSC(interface_number) \
|
||||
APP_USBD_HID_MOUSE_HID_DSC(rep_desc) \
|
||||
APP_USBD_HID_MOUSE_EP_DSC(endpoint) \
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* @brief Configure internal part of HID mouse instance
|
||||
*
|
||||
* @param descriptors Raw descriptors buffer
|
||||
* @param report_desc Report descriptor
|
||||
* @param report_buff_in Input report buffers array
|
||||
* @param report_buff_out Output report buffer
|
||||
* @param user_ev_handler User event handler
|
||||
* @param bcnt Mouse button count
|
||||
*/
|
||||
#define APP_USBD_HID_MOUSE_INST_CONFIG(descriptors, \
|
||||
report_desc, \
|
||||
report_buff_in, \
|
||||
report_buff_out, \
|
||||
user_ev_handler, \
|
||||
bcnt) \
|
||||
.inst = { \
|
||||
.hid_inst = APP_USBD_HID_INST_CONFIG(descriptors, \
|
||||
report_desc, \
|
||||
report_buff_in, \
|
||||
report_buff_out, \
|
||||
user_ev_handler, \
|
||||
&app_usbd_hid_mouse_methods), \
|
||||
.button_count = bcnt, \
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Public HID mouse interface
|
||||
* */
|
||||
extern const app_usbd_hid_methods_t app_usbd_hid_mouse_methods;
|
||||
|
||||
/**
|
||||
* @brief Public HID mouse class interface
|
||||
* */
|
||||
extern const app_usbd_class_methods_t app_usbd_hid_mouse_class_methods;
|
||||
|
||||
/**
|
||||
* @brief Global definition of app_usbd_hid_mouse_t class
|
||||
*
|
||||
* @ref APP_USBD_HID_MOUSE_GLOBAL_DEF
|
||||
*/
|
||||
#define APP_USBD_HID_MOUSE_GLOBAL_DEF_INTERNAL(instance_name, \
|
||||
interface_number, \
|
||||
endpoint, \
|
||||
bcnt, \
|
||||
user_ev_handler) \
|
||||
static const uint8_t CONCAT_2(instance_name, _rep_dsc)[] = \
|
||||
APP_USBD_HID_MOUSE_REPORT_DSC_BUTTON(bcnt); \
|
||||
static const uint8_t CONCAT_2(instance_name, _dsc)[] = \
|
||||
APP_USBD_HID_MOUSE_DSC_CONFIG(interface_number, \
|
||||
endpoint, \
|
||||
CONCAT_2(instance_name, \
|
||||
_rep_dsc)); \
|
||||
static app_usbd_hid_report_buffer_t CONCAT_2(instance_name, _in)[1]; \
|
||||
APP_USBD_CLASS_INST_GLOBAL_DEF( \
|
||||
instance_name, \
|
||||
app_usbd_hid_mouse, \
|
||||
&app_usbd_hid_mouse_class_methods, \
|
||||
APP_USBD_HID_MOUSE_CONFIG(interface_number, endpoint), \
|
||||
(APP_USBD_HID_MOUSE_INST_CONFIG(CONCAT_2(instance_name, _dsc), \
|
||||
CONCAT_2(instance_name, _rep_dsc), \
|
||||
CONCAT_2(instance_name, _in), \
|
||||
NULL, \
|
||||
user_ev_handler, \
|
||||
bcnt)) \
|
||||
)
|
||||
|
||||
|
||||
/** @} */
|
||||
|
||||
#endif /* APP_USBD_HID_MOUSE_INTERNAL_H__ */
|
||||
Reference in New Issue
Block a user