summaryrefslogtreecommitdiffstats
path: root/mtp/ffs/MtpDevice.h
blob: da00a81a34f1b78c3ba5ddb362f2fbe20fe5e379 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
/*
 * Copyright (C) 2010 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *		http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef _MTP_DEVICE_H
#define _MTP_DEVICE_H

#include "MtpEventPacket.h"
#include "MtpDataPacket.h"
#include "MtpRequestPacket.h"
#include "MtpResponsePacket.h"
#include "MtpTypes.h"

#include <mutex>

struct usb_device;
struct usb_request;
struct usb_endpoint_descriptor;

class MtpDeviceInfo;
class MtpEventPacket;
class MtpObjectInfo;
class MtpStorageInfo;

class MtpDevice {
private:
	struct usb_device*		mDevice;
	int						mInterface;
	struct usb_request*		mRequestIn1;
	struct usb_request*		mRequestIn2;
	struct usb_request*		mRequestOut;
	struct usb_request*		mRequestIntr;
	MtpDeviceInfo*			mDeviceInfo;
	MtpPropertyList			mDeviceProperties;

	// current session ID
	MtpSessionID			mSessionID;
	// current transaction ID
	MtpTransactionID		mTransactionID;

	MtpRequestPacket		mRequest;
	MtpDataPacket			mData;
	MtpResponsePacket		mResponse;
	MtpEventPacket			mEventPacket;

	// set to true if we received a response packet instead of a data packet
	bool					mReceivedResponse;
	bool					mProcessingEvent;
	int						mCurrentEventHandle;

	// to check if a sendObject request follows the last sendObjectInfo request.
	MtpTransactionID		mLastSendObjectInfoTransactionID;
	MtpObjectHandle			mLastSendObjectInfoObjectHandle;

	// to ensure only one MTP transaction at a time
	std::mutex				mMutex;
	std::mutex				mEventMutex;
	std::mutex				mEventMutexForInterrupt;

	// Remember the device's packet division mode.
	UrbPacketDivisionMode	mPacketDivisionMode;

public:
	typedef bool (*ReadObjectCallback)
			(void* data, uint32_t offset, uint32_t length, void* clientData);

	MtpDevice(struct usb_device* device,
			  int interface,
			  const struct usb_endpoint_descriptor *ep_in,
			  const struct usb_endpoint_descriptor *ep_out,
			  const struct usb_endpoint_descriptor *ep_intr);

	static MtpDevice*		open(const char* deviceName, int fd);

	virtual					~MtpDevice();

	void					initialize();
	void					close();
	void					print();
	const char*				getDeviceName();

	bool					openSession();
	bool					closeSession();

	MtpDeviceInfo*			getDeviceInfo();
	MtpStorageIDList*		getStorageIDs();
	MtpStorageInfo*			getStorageInfo(MtpStorageID storageID);
	MtpObjectHandleList*	getObjectHandles(MtpStorageID storageID, MtpObjectFormat format,
									MtpObjectHandle parent);
	MtpObjectInfo*			getObjectInfo(MtpObjectHandle handle);
	void*					getThumbnail(MtpObjectHandle handle, int& outLength);
	MtpObjectHandle			sendObjectInfo(MtpObjectInfo* info);
	bool					sendObject(MtpObjectHandle handle, int size, int srcFD);
	bool					deleteObject(MtpObjectHandle handle);
	MtpObjectHandle			getParent(MtpObjectHandle handle);
	MtpStorageID			getStorageID(MtpObjectHandle handle);

	MtpObjectPropertyList*	getObjectPropsSupported(MtpObjectFormat format);

	MtpProperty*			getDevicePropDesc(MtpDeviceProperty code);
	MtpProperty*			getObjectPropDesc(MtpObjectProperty code, MtpObjectFormat format);

	// Reads value of |property| for |handle|. Returns true on success.
	bool					getObjectPropValue(MtpObjectHandle handle, MtpProperty* property);

	bool					readObject(MtpObjectHandle handle, ReadObjectCallback callback,
									uint32_t objectSize, void* clientData);
	bool					readObject(MtpObjectHandle handle, const char* destPath, int group,
									int perm);
	bool					readObject(MtpObjectHandle handle, int fd);
	bool					readPartialObject(MtpObjectHandle handle,
											  uint32_t offset,
											  uint32_t size,
											  uint32_t *writtenSize,
											  ReadObjectCallback callback,
											  void* clientData);
	bool					readPartialObject64(MtpObjectHandle handle,
												uint64_t offset,
												uint32_t size,
												uint32_t *writtenSize,
												ReadObjectCallback callback,
												void* clientData);
	// Starts a request to read MTP event from MTP device. It returns a request handle that
	// can be used for blocking read or cancel. If other thread has already been processing an
	// event returns -1.
	int						submitEventRequest();
	// Waits for MTP event from the device and returns MTP event code. It blocks the current thread
	// until it receives an event from the device. |handle| should be a request handle returned
	// by |submitEventRequest|. The function writes event parameters to |parameters|. Returns 0 for
	// cancellations. Returns -1 for errors.
	int						reapEventRequest(int handle, uint32_t (*parameters)[3]);
	// Cancels an event request. |handle| should be request handle returned by
	// |submitEventRequest|. If there is a thread blocked by |reapEventRequest| with the same
	// |handle|, the thread will resume.
	void					discardEventRequest(int handle);

private:
	// If |objectSize| is not NULL, it checks object size before reading data bytes.
	bool					readObjectInternal(MtpObjectHandle handle,
											   ReadObjectCallback callback,
											   const uint32_t* objectSize,
											   void* clientData);
	// If |objectSize| is not NULL, it checks object size before reading data bytes.
	bool					readData(ReadObjectCallback callback,
									 const uint32_t* objectSize,
									 uint32_t* writtenData,
									 void* clientData);
	bool					sendRequest(MtpOperationCode operation);
	bool					sendData();
	bool					readData();
	bool					writeDataHeader(MtpOperationCode operation, int dataLength);
	MtpResponseCode			readResponse();
};

#endif // _MTP_DEVICE_H