summaryrefslogtreecommitdiff
path: root/libopie2/opiecore/linux/opcmciasystem.h
Unidiff
Diffstat (limited to 'libopie2/opiecore/linux/opcmciasystem.h') (more/less context) (ignore whitespace changes)
-rw-r--r--libopie2/opiecore/linux/opcmciasystem.h8
1 files changed, 6 insertions, 2 deletions
diff --git a/libopie2/opiecore/linux/opcmciasystem.h b/libopie2/opiecore/linux/opcmciasystem.h
index 23d8c41..fecbb21 100644
--- a/libopie2/opiecore/linux/opcmciasystem.h
+++ b/libopie2/opiecore/linux/opcmciasystem.h
@@ -1,180 +1,184 @@
1/* 1/*
2                 This file is part of the Opie Project 2                 This file is part of the Opie Project
3 =. (C) 2005 Michael 'Mickey' Lauer <mickey@Vanille.de> 3 =. (C) 2005 Michael 'Mickey' Lauer <mickey@Vanille.de>
4 .=l. 4 .=l.
5           .>+-= 5           .>+-=
6 _;:,     .>    :=|. This program is free software; you can 6 _;:,     .>    :=|. This program is free software; you can
7.> <`_,   >  .   <= redistribute it and/or modify it under 7.> <`_,   >  .   <= redistribute it and/or modify it under
8:`=1 )Y*s>-.--   : the terms of the GNU Library General Public 8:`=1 )Y*s>-.--   : the terms of the GNU Library General Public
9.="- .-=="i,     .._ License as published by the Free Software 9.="- .-=="i,     .._ License as published by the Free Software
10 - .   .-<_>     .<> Foundation; version 2 of the License. 10 - .   .-<_>     .<> Foundation; version 2 of the License.
11     ._= =}       : 11     ._= =}       :
12    .%`+i>       _;_. 12    .%`+i>       _;_.
13    .i_,=:_.      -<s. This program is distributed in the hope that 13    .i_,=:_.      -<s. This program is distributed in the hope that
14     +  .  -:.       = it will be useful, but WITHOUT ANY WARRANTY; 14     +  .  -:.       = it will be useful, but WITHOUT ANY WARRANTY;
15    : ..    .:,     . . . without even the implied warranty of 15    : ..    .:,     . . . without even the implied warranty of
16    =_        +     =;=|` MERCHANTABILITY or FITNESS FOR A 16    =_        +     =;=|` MERCHANTABILITY or FITNESS FOR A
17  _.=:.       :    :=>`: PARTICULAR PURPOSE. See the GNU 17  _.=:.       :    :=>`: PARTICULAR PURPOSE. See the GNU
18..}^=.=       =       ; Library General Public License for more 18..}^=.=       =       ; Library General Public License for more
19++=   -.     .`     .: details. 19++=   -.     .`     .: details.
20 :     =  ...= . :.=- 20 :     =  ...= . :.=-
21 -.   .:....=;==+<; You should have received a copy of the GNU 21 -.   .:....=;==+<; You should have received a copy of the GNU
22  -_. . .   )=.  = Library General Public License along with 22  -_. . .   )=.  = Library General Public License along with
23    --        :-=` this library; see the file COPYING.LIB. 23    --        :-=` this library; see the file COPYING.LIB.
24 If not, write to the Free Software Foundation, 24 If not, write to the Free Software Foundation,
25 Inc., 59 Temple Place - Suite 330, 25 Inc., 59 Temple Place - Suite 330,
26 Boston, MA 02111-1307, USA. 26 Boston, MA 02111-1307, USA.
27 27
28*/ 28*/
29 29
30#ifndef OPCMCIASYSTEM_H 30#ifndef OPCMCIASYSTEM_H
31#define OPCMCIASYSTEM_H 31#define OPCMCIASYSTEM_H
32 32
33#include "linux_pcmcia.h" 33#include "linux_pcmcia.h"
34 34
35#include <qobject.h> 35#include <qobject.h>
36#include <qlist.h> 36#include <qlist.h>
37 37
38namespace Opie { 38namespace Opie {
39namespace Core { 39namespace Core {
40 40
41class OPcmciaSocket; 41class OPcmciaSocket;
42 42
43/*====================================================================================== 43/*======================================================================================
44 * OPcmciaSystem 44 * OPcmciaSystem
45 *======================================================================================*/ 45 *======================================================================================*/
46 46
47/** 47/**
48 * @brief A container class for the linux pcmcia subsystem 48 * @brief A container class for the linux pcmcia subsystem
49 * 49 *
50 * This class provides access to all available pcmcia/cf cards on your device. 50 * This class provides access to all available pcmcia/cf cards on your device.
51 * 51 *
52 * @author Michael 'Mickey' Lauer <mickey@Vanille.de> 52 * @author Michael 'Mickey' Lauer <mickey@Vanille.de>
53 */ 53 */
54class OPcmciaSystem : public QObject 54class OPcmciaSystem : public QObject
55{ 55{
56 Q_OBJECT 56 Q_OBJECT
57 57
58 public: 58 public:
59 typedef QList<OPcmciaSocket> CardList; 59 typedef QList<OPcmciaSocket> CardList;
60 typedef QListIterator<OPcmciaSocket> CardIterator; 60 typedef QListIterator<OPcmciaSocket> CardIterator;
61 61
62 public: 62 public:
63 /** 63 /**
64 * @returns the number of available sockets 64 * @returns the number of available sockets
65 */ 65 */
66 int count() const; 66 int count() const;
67 /** 67 /**
68 * @returns the number of populated sockets 68 * @returns the number of populated sockets
69 */ 69 */
70 int cardCount() const; 70 int cardCount() const;
71 /** 71 /**
72 * @returns a pointer to the (one and only) @ref OSystem instance. 72 * @returns a pointer to the (one and only) @ref OSystem instance
73 */ 73 */
74 static OPcmciaSystem* instance(); 74 static OPcmciaSystem* instance();
75 /** 75 /**
76 * @returns an iterator usable for iterating through all sound cards. 76 * @returns an iterator usable for iterating through all sound cards
77 */ 77 */
78 CardIterator iterator() const; 78 CardIterator iterator() const;
79 /** 79 /**
80 * @returns a pointer to the @ref OPcmciaSocket object correspinding to socket number n, or 0, if not found 80 * @returns a pointer to the @ref OPcmciaSocket object correspinding to socket number n, or 0, if not found
81 * @see OPcmciaSocket 81 * @see OPcmciaSocket
82 */ 82 */
83 OPcmciaSocket* socket( unsigned int number ); 83 OPcmciaSocket* socket( unsigned int number );
84 /** 84 /**
85 * Restarts the subsystem
86 */
87 void restart();
88 /**
85 * @internal Rebuild the internal database 89 * @internal Rebuild the internal database
86 * @note Sometimes it might be useful to call this from client code, 90 * @note Sometimes it might be useful to call this from client code,
87 * e.g. after issuing a cardctl insert 91 * e.g. after issuing a cardctl insert
88 */ 92 */
89 void synchronize(); 93 void synchronize();
90 94
91 protected: 95 protected:
92 OPcmciaSystem(); 96 OPcmciaSystem();
93 97
94 private: 98 private:
95 static OPcmciaSystem* _instance; 99 static OPcmciaSystem* _instance;
96 CardList _interfaces; 100 CardList _interfaces;
97 int _major; 101 int _major;
98 102
99 private: 103 private:
100 class Private; 104 class Private;
101 Private *d; 105 Private *d;
102}; 106};
103 107
104 108
105/*====================================================================================== 109/*======================================================================================
106 * OPcmciaSocket 110 * OPcmciaSocket
107 *======================================================================================*/ 111 *======================================================================================*/
108 112
109class OPcmciaSocket : public QObject 113class OPcmciaSocket : public QObject
110{ 114{
111 Q_OBJECT 115 Q_OBJECT
112 public: 116 public:
113 117
114 enum OPcmciaSocketCardStatus 118 enum OPcmciaSocketCardStatus
115 { 119 {
116 Unknown = 0, 120 Unknown = 0,
117 Occupied = CS_EVENT_CARD_DETECT, 121 Occupied = CS_EVENT_CARD_DETECT,
118 OccupiedCardBus = CS_EVENT_CB_DETECT, 122 OccupiedCardBus = CS_EVENT_CB_DETECT,
119 WriteProtected = CS_EVENT_WRITE_PROTECT, 123 WriteProtected = CS_EVENT_WRITE_PROTECT,
120 BatteryLow = CS_EVENT_BATTERY_LOW, 124 BatteryLow = CS_EVENT_BATTERY_LOW,
121 BatteryDead = CS_EVENT_BATTERY_DEAD, 125 BatteryDead = CS_EVENT_BATTERY_DEAD,
122 Ready = CS_EVENT_READY_CHANGE, 126 Ready = CS_EVENT_READY_CHANGE,
123 Suspended = CS_EVENT_PM_SUSPEND, 127 Suspended = CS_EVENT_PM_SUSPEND,
124 Attention = CS_EVENT_REQUEST_ATTENTION, 128 Attention = CS_EVENT_REQUEST_ATTENTION,
125 InsertionInProgress = CS_EVENT_CARD_INSERTION, 129 InsertionInProgress = CS_EVENT_CARD_INSERTION,
126 RemovalInProgress = CS_EVENT_CARD_REMOVAL, 130 RemovalInProgress = CS_EVENT_CARD_REMOVAL,
127 ThreeVolts = CS_EVENT_3VCARD, 131 ThreeVolts = CS_EVENT_3VCARD,
128 SupportsVoltage = CS_EVENT_XVCARD, 132 SupportsVoltage = CS_EVENT_XVCARD,
129 }; 133 };
130 134
131 public: 135 public:
132 /** 136 /**
133 * Constructor. Normally you don't create @ref OPcmciaSocket objects yourself, 137 * Constructor. Normally you don't create @ref OPcmciaSocket objects yourself,
134 * but access them via @ref OPcmciaSystem::socket(). 138 * but access them via @ref OPcmciaSystem::socket().
135 */ 139 */
136 OPcmciaSocket( int major, int socket, QObject* parent, const char* name ); 140 OPcmciaSocket( int major, int socket, QObject* parent, const char* name );
137 /** 141 /**
138 * Destructor. 142 * Destructor.
139 */ 143 */
140 virtual ~OPcmciaSocket(); 144 virtual ~OPcmciaSocket();
141 /** 145 /**
142 * @returns the corresponding socket number 146 * @returns the corresponding socket number
143 */ 147 */
144 int number() const; 148 int number() const;
145 /** 149 /**
146 * @returns the card managers idea of the cards' identy, or "<Empty Socket>" 150 * @returns the card managers idea of the cards' identy, or "<Empty Socket>"
147 */ 151 */
148 QString identity() const; 152 QString identity() const;
149 /** 153 /**
150 * @returns the socket status 154 * @returns the socket status
151 */ 155 */
152 const OPcmciaSocketCardStatus status() const; 156 const OPcmciaSocketCardStatus status() const;
153 /** 157 /**
154 * @returns true, if the card is unsupported by the cardmgr 158 * @returns true, if the card is unsupported by the cardmgr
155 */ 159 */
156 bool isUnsupported() const; 160 bool isUnsupported() const;
157 /** 161 /**
158 * @returns true, if the socket is empty 162 * @returns true, if the socket is empty
159 */ 163 */
160 bool isEmpty() const; 164 bool isEmpty() const;
161 /** 165 /**
162 * @returns true, if the socket is suspended 166 * @returns true, if the socket is suspended
163 */ 167 */
164 bool isSuspended() const; 168 bool isSuspended() const;
165 /** 169 /**
166 * Eject card. @returns true, if operation succeeded 170 * Eject card. @returns true, if operation succeeded
167 * @note: This operation needs root privileges 171 * @note: This operation needs root privileges
168 */ 172 */
169 bool eject(); 173 bool eject();
170 /** 174 /**
171 * Insert card. @returns true, if operation succeeded 175 * Insert card. @returns true, if operation succeeded
172 * @note: This operation needs root privileges 176 * @note: This operation needs root privileges
173 */ 177 */
174 bool insert(); 178 bool insert();
175 /** 179 /**
176 * Suspend card. @returns true, if operation succeeded 180 * Suspend card. @returns true, if operation succeeded
177 * @note: This operation needs root privileges 181 * @note: This operation needs root privileges
178 */ 182 */
179 bool suspend(); 183 bool suspend();
180 /** 184 /**