USB.Device.HID

Entities

Tagged Types

Access Types

Subprograms

Description

---------------------------------------------------------------------------- -- Copyright (C) 2018-2021, AdaCore -- -- 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 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 the copyright holder nor the names of its -- contributors may be used to endorse or promote products derived -- from this software without specific prior written permission. -- -- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS -- "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT -- LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR -- A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT -- HOLDER 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. -- -- ----------------------------------------------------------------------------

Abstract_HID_Class

type Abstract_HID_Class (Report_Size : Packet_Size := 1)
is abstract limited new USB_Device_Class with private;

Ready

function Ready (This : in out Abstract_HID_Class) return Boolean

The class is ready to send a report

Parameters
This
Return Value

Report_Descriptor

function Report_Descriptor (This : Abstract_HID_Class)
                            return not null Report_Descriptor_Access

HID implementations must return an access to their report descriptor

Parameters
This
Return Value

Report_Descriptor_Access

type Report_Descriptor_Access is access constant UInt8_Array;

HID implementations must return an access to their report descriptor

Send_Report

procedure Send_Report (This : in out Abstract_HID_Class;
                       UDC  : in out USB_Device_Controller'Class)

Send a report to the host

Parameters
This
UDC

Set_Report

function Set_Report (This : in out Abstract_HID_Class;
                     Typ  :        UInt8;
                     ID   :        UInt8;
                     Data :        UInt8_Array)
                     return Setup_Request_Answer

Called when the Host sends a Set_Report control transfer. For instance for LED status on a keyboard.

Parameters
This
Typ
ID
Data
Return Value