UcxUserRequest Class Reference

Public Member Functions
	UcxUserRequest (_In_ PUSBUSER_REQUEST_HEADER Header, _In_ ULONG BufferLength)
template<typename T >
T *	Payload () const
PUSBUSER_REQUEST_HEADER	Header () const
ULONG	NameSpace () const
VOID	SetStatus (_In_ USB_USER_ERROR_CODE Status)
BOOLEAN	CheckParameterLength (_In_ ULONG ParameterLength)

Private Attributes
PUSBUSER_REQUEST_HEADER	m_Header
ULONG	m_BufferLength

Detailed Description

One IOCTL_USB_USER_REQUEST: the header and the payload right after it.

Definition at line 34 of file userreq.cpp.

Constructor & Destructor Documentation

UcxUserRequest()

UcxUserRequest::UcxUserRequest ( _In_ PUSBUSER_REQUEST_HEADER  Header, _In_ ULONG  BufferLength  )

inline

Definition at line 37 of file userreq.cpp.

        : m_Header(Header),
          m_BufferLength(BufferLength)
    {
    }

Member Function Documentation

CheckParameterLength()

BOOLEAN UcxUserRequest::CheckParameterLength ( _In_ ULONG  ParameterLength )

inline

The total size is reported even when it does not fit.

Definition at line 73 of file userreq.cpp.

    {
        m_Header->ActualBufferLength = UCX_USER_HEADER_SIZE + ParameterLength;
 
        if (m_Header->ActualBufferLength > m_Header->RequestBufferLength)
        {
            DPRINT1("USBUSER request 0x%lx needs %lu bytes, got %lu\n",
                    m_Header->UsbUserRequest, m_Header->ActualBufferLength, m_Header->RequestBufferLength);
            SetStatus(UsbUserBufferTooSmall);
            return FALSE;
        }
 
        return TRUE;
    }

Header()

PUSBUSER_REQUEST_HEADER UcxUserRequest::Header ( ) const

inline

Definition at line 53 of file userreq.cpp.

    {
        return m_Header;
    }

NameSpace()

ULONG UcxUserRequest::NameSpace ( ) const

inline

Definition at line 59 of file userreq.cpp.

    {
        return m_BufferLength - UCX_USER_HEADER_SIZE;
    }

Payload()

template<typename T >

T * UcxUserRequest::Payload ( ) const

inline

Definition at line 47 of file userreq.cpp.

    {
        return (T*)(m_Header + 1);
    }

SetStatus()

VOID UcxUserRequest::SetStatus ( _In_ USB_USER_ERROR_CODE  Status )

inline

Definition at line 65 of file userreq.cpp.

    {
        m_Header->UsbUserStatusCode = Status;
    }

Referenced by CheckParameterLength().

Member Data Documentation

m_BufferLength

ULONG UcxUserRequest::m_BufferLength

private

Definition at line 91 of file userreq.cpp.

Referenced by NameSpace().

m_Header

PUSBUSER_REQUEST_HEADER UcxUserRequest::m_Header

private

Definition at line 90 of file userreq.cpp.

Referenced by CheckParameterLength(), Header(), Payload(), and SetStatus().

---

The documentation for this class was generated from the following file:

• drivers/usb/ucx01000/userreq.cpp