• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (C) 2006 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #ifndef ANDROID_USB_INTERRUPT_PIPE_FILE_OBJECT_H__
18 #define ANDROID_USB_INTERRUPT_PIPE_FILE_OBJECT_H__
19 /** \file
20   This file consists of declaration of class AndroidUsbInterruptPipeFileObject
21   that encapsulates extension to an interrupt pipe file objects.
22 */
23 
24 #include "android_usb_pipe_file_object.h"
25 
26 /** AndroidUsbInterruptPipeFileObject class encapsulates extension for a KMDF
27   file object that represent opened interrupt pipe. Instances of this class
28   must be allocated from NonPagedPool.
29 */
30 class AndroidUsbInterruptPipeFileObject : public AndroidUsbPipeFileObject {
31  public:
32   /** \brief Constructs the object.
33 
34     This method must be called at low IRQL.
35     @param dev_obj[in] Our device object for which this file has been created
36     @param wdf_fo[in] KMDF file object this extension wraps
37     @param wdf_pipe_obj[in] KMDF pipe for this file
38   */
39   AndroidUsbInterruptPipeFileObject(AndroidUsbDeviceObject* dev_obj,
40                                     WDFFILEOBJECT wdf_fo,
41                                     WDFUSBPIPE wdf_pipe_obj);
42 
43   /** \brief Destructs the object.
44 
45     This method can be called at any IRQL.
46   */
47    virtual ~AndroidUsbInterruptPipeFileObject();
48 };
49 
50 #endif  // ANDROID_USB_INTERRUPT_PIPE_FILE_OBJECT_H__
51