Upgrade doxygen configuration files to the latest version.

[pub/lufa.git] / LUFA / Drivers / USB / Class / Device / CCIDClassDevice.h

diff --git a/LUFA/Drivers/USB/Class/Device/CCIDClassDevice.h b/LUFA/Drivers/USB/Class/Device/CCIDClassDevice.h
index 05f487f..48803fd 100644 (file)
--- a/LUFA/Drivers/USB/Class/Device/CCIDClassDevice.h
+++ b/LUFA/Drivers/USB/Class/Device/CCIDClassDevice.h
@@ -1,14 +1,14 @@
 /*
              LUFA Library
 /*
              LUFA Library

-     Copyright (C) Dean Camera, 2018.
+     Copyright (C) Dean Camera, 2021.

 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*
 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*

-  Copyright 2018  Dean Camera (dean [at] fourwalledcubicle [dot] com)
-  Copyright 2018  Filipe Rodrigues (filipepazrodrigues [at] gmail [dot] com)
+  Copyright 2021  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2021  Filipe Rodrigues (filipepazrodrigues [at] gmail [dot] com)

 
   Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted
 
   Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted


@@ -125,7 +125,7 @@
                         *  \return     The command result code.
                         */
                        uint8_t CALLBACK_CCID_IccPowerOn(USB_ClassInfo_CCID_Device_t* const CCIDInterfaceInfo,
                         *  \return     The command result code.
                         */
                        uint8_t CALLBACK_CCID_IccPowerOn(USB_ClassInfo_CCID_Device_t* const CCIDInterfaceInfo,

-                                                        uint8_t Slot,
+                                                        const uint8_t Slot,

                                                         uint8_t* const Atr,
                                                         uint8_t* const AtrSize,
                                                         uint8_t* const Error) ATTR_NON_NULL_PTR_ARG(1);
                                                         uint8_t* const Atr,
                                                         uint8_t* const AtrSize,
                                                         uint8_t* const Error) ATTR_NON_NULL_PTR_ARG(1);


@@ -140,20 +140,20 @@
                         *  \return     The command result code.
                         */
                        uint8_t CALLBACK_CCID_IccPowerOff(USB_ClassInfo_CCID_Device_t* const CCIDInterfaceInfo,
                         *  \return     The command result code.
                         */
                        uint8_t CALLBACK_CCID_IccPowerOff(USB_ClassInfo_CCID_Device_t* const CCIDInterfaceInfo,

-                                                         uint8_t Slot,
+                                                         const uint8_t Slot,

                                                          uint8_t* const Error) ATTR_NON_NULL_PTR_ARG(1);
 
                        /** CCID class driver callback for PC_TO_RDR_GetSlotStatus CCID message
                         *  Retrieves the current status of a given slot
                         *
                         *      \param[in,out] CCIDInterfaceInfo        Pointer to a structure containing a CCID Class configuration and state.
                                                          uint8_t* const Error) ATTR_NON_NULL_PTR_ARG(1);
 
                        /** CCID class driver callback for PC_TO_RDR_GetSlotStatus CCID message
                         *  Retrieves the current status of a given slot
                         *
                         *      \param[in,out] CCIDInterfaceInfo        Pointer to a structure containing a CCID Class configuration and state.

-                        *  \param[in]     slot                                 The slot ID from which we want to retrieve the status.
-                        *  \param[out]    error                                The result of the operation, or error.
+                        *  \param[in]     Slot                                 The slot ID from which we want to retrieve the status.
+                        *  \param[out]    Error                                The result of the operation, or error.

                         *
                         *  \return     The command result code.
                         */
                        uint8_t CALLBACK_CCID_GetSlotStatus(USB_ClassInfo_CCID_Device_t* const CCIDInterfaceInfo,
                         *
                         *  \return     The command result code.
                         */
                        uint8_t CALLBACK_CCID_GetSlotStatus(USB_ClassInfo_CCID_Device_t* const CCIDInterfaceInfo,

-                                                           uint8_t Slot,
+                                                           const uint8_t Slot,

                                                            uint8_t* const Error) ATTR_NON_NULL_PTR_ARG(1);
 
 
                                                            uint8_t* const Error) ATTR_NON_NULL_PTR_ARG(1);
 
 


@@ -168,9 +168,9 @@
                         *  \return     The command result code.
                         */
                        uint8_t CALLBACK_CCID_SetParameters_T0(USB_ClassInfo_CCID_Device_t* const CCIDInterfaceInfo,
                         *  \return     The command result code.
                         */
                        uint8_t CALLBACK_CCID_SetParameters_T0(USB_ClassInfo_CCID_Device_t* const CCIDInterfaceInfo,

-                                                                                                  uint8_t Slot,
+                                                                                                  const uint8_t Slot,

                                                                                                   uint8_t* const Error,
                                                                                                   uint8_t* const Error,

-                                                                                                  USB_CCID_ProtocolData_T0_t* const T0);
+                                                                                                  USB_CCID_ProtocolData_T0_t* const T0) ATTR_NON_NULL_PTR_ARG(1);

 
                        /** CCID class driver callback for PC_TO_RDR_SetParameters CCID message for T=0
                         *  Retrieves the current parameters of a given slot
 
                        /** CCID class driver callback for PC_TO_RDR_SetParameters CCID message for T=0
                         *  Retrieves the current parameters of a given slot


@@ -178,15 +178,16 @@
                         *  \param[in,out] CCIDInterfaceInfo    Pointer to a structure containing a CCID Class configuration, state and protocol data.
                         *  \param[in]     Slot                                 The slot ID from which we want to retrieve the status.
                         *  \param[out]    Error                                The result of the operation, or error.
                         *  \param[in,out] CCIDInterfaceInfo    Pointer to a structure containing a CCID Class configuration, state and protocol data.
                         *  \param[in]     Slot                                 The slot ID from which we want to retrieve the status.
                         *  \param[out]    Error                                The result of the operation, or error.

+                        *  \param[out]    ProtocolNum                  The CCID protocol ID of the parameter being retrieved.

                         *  \param[out]    T0                                   Pointer to a buffer where the parameters will be returned
                         *
                         *  \return     The command result code.
                         */
                        uint8_t CALLBACK_CCID_GetParameters_T0(USB_ClassInfo_CCID_Device_t* const CCIDInterfaceInfo,
                         *  \param[out]    T0                                   Pointer to a buffer where the parameters will be returned
                         *
                         *  \return     The command result code.
                         */
                        uint8_t CALLBACK_CCID_GetParameters_T0(USB_ClassInfo_CCID_Device_t* const CCIDInterfaceInfo,

-                                                                                                  uint8_t Slot,
+                                                                                                  const uint8_t Slot,

                                                                                                   uint8_t* const Error,
                                                                                                   uint8_t* const ProtocolNum,
                                                                                                   uint8_t* const Error,
                                                                                                   uint8_t* const ProtocolNum,

-                                                                                                  USB_CCID_ProtocolData_T0_t* const T0);
+                                                                                                  USB_CCID_ProtocolData_T0_t* const T0) ATTR_NON_NULL_PTR_ARG(1);

 
                        /** CCID class driver callback for PC_TO_RDR_XfrBlock CCID message
                         *  Send a block of bytes from the host to a slot in the device
 
                        /** CCID class driver callback for PC_TO_RDR_XfrBlock CCID message
                         *  Send a block of bytes from the host to a slot in the device


@@ -203,12 +204,12 @@
                         *  \return     The command result code.
                         */
                        uint8_t CALLBACK_CCID_XfrBlock(USB_ClassInfo_CCID_Device_t* const CCIDInterfaceInfo,
                         *  \return     The command result code.
                         */
                        uint8_t CALLBACK_CCID_XfrBlock(USB_ClassInfo_CCID_Device_t* const CCIDInterfaceInfo,

-                                                                                  uint8_t Slot,
-                                                                                  uint8_t* const ReceivedBuffer,
-                                                                                  uint8_t ReceivedBufferSize,
+                                                                                  const uint8_t Slot,
+                                                                                  const uint8_t* ReceivedBuffer,
+                                                                                  const uint8_t ReceivedBufferSize,

                                                                                   uint8_t* const SendBuffer,
                                                                                   uint8_t* const SentBufferSize,
                                                                                   uint8_t* const SendBuffer,
                                                                                   uint8_t* const SentBufferSize,

-                                                                                  uint8_t* const Error);
+                                                                                  uint8_t* const Error) ATTR_NON_NULL_PTR_ARG(1);

 
                        /** CCID class driver callback for CCID_PC_to_RDR_Abort CCID message
                         *  Aborts a BULK out message previously sent to a slot
 
                        /** CCID class driver callback for CCID_PC_to_RDR_Abort CCID message
                         *  Aborts a BULK out message previously sent to a slot


@@ -222,8 +223,8 @@
                         *  \return     The command result code.
                         */
                        uint8_t CALLBACK_CCID_Abort(USB_ClassInfo_CCID_Device_t* const CCIDInterfaceInfo,
                         *  \return     The command result code.
                         */
                        uint8_t CALLBACK_CCID_Abort(USB_ClassInfo_CCID_Device_t* const CCIDInterfaceInfo,

-                                                   uint8_t Slot,
-                                                   uint8_t Seq,
+                                                   const uint8_t Slot,
+                                                   const uint8_t Seq,

                                                    uint8_t* const Error) ATTR_NON_NULL_PTR_ARG(1);
 
 
                                                    uint8_t* const Error) ATTR_NON_NULL_PTR_ARG(1);