add some comments to Zaurus class

1 files changed, 17 insertions, 0 deletions

diff --git a/libopie/odevice.cpp b/libopie/odevice.cpp
index 71ed9e4..9373ef9 100644
--- a/libopie/odevice.cpp
+++ b/libopie/odevice.cpp
@@ -1368,386 +1368,400 @@ void iPAQ::alarmSound ( )
                         cfg. setGroup ( "Volume" );
 
                         int volalarm = cfg. readNumEntry ( "AlarmPercent", 50 );
                         if ( volalarm < 0 )
                                 volalarm = 0;
                         else if ( volalarm > 100 )
                                 volalarm = 100;
                         volalarm |= ( volalarm << 8 );
 
                         if ( ::ioctl ( fd, MIXER_WRITE( 0 ), &volalarm ) >= 0 )
                                 vol_reset = true;
                 }
         }
 
         snd. play ( );
         while ( !snd. isFinished ( ))
                 qApp-> processEvents ( );
 
         if ( fd >= 0 ) {
                 if ( vol_reset )
                         ::ioctl ( fd, MIXER_WRITE( 0 ), &vol );
                 ::close ( fd );
         }
 #endif
 }
 
 
 bool iPAQ::setSoftSuspend ( bool soft )
 {
         bool res = false;
         int fd;
 
         if (( fd = ::open ( "/proc/sys/ts/suspend_button_mode", O_WRONLY )) >= 0 ) {
                 if ( ::write ( fd, soft ? "1" : "0", 1 ) == 1 )
                         res = true;
                 else
                         ::perror ( "write to /proc/sys/ts/suspend_button_mode" );
 
                 ::close ( fd );
         }
         else
                 ::perror ( "/proc/sys/ts/suspend_button_mode" );
 
         return res;
 }
 
 
 bool iPAQ::setDisplayBrightness ( int bright )
 {
         bool res = false;
         int fd;
 
         if ( bright > 255 )
                 bright = 255;
         if ( bright < 0 )
                 bright = 0;
 
         if (( fd = ::open ( "/dev/touchscreen/0", O_WRONLY )) >= 0 ) {
                 FLITE_IN bl;
                 bl. mode = 1;
                 bl. pwr = bright ? 1 : 0;
                 bl. brightness = ( bright * ( displayBrightnessResolution ( ) - 1 ) + 127 ) / 255;
                 res = ( ::ioctl ( fd, FLITE_ON, &bl ) == 0 );
                 ::close ( fd );
         }
         return res;
 }
 
 int iPAQ::displayBrightnessResolution ( ) const
 {
         switch ( model ( )) {
                 case Model_iPAQ_H31xx:
                 case Model_iPAQ_H36xx:
                 case Model_iPAQ_H37xx:
                                 return 128;  // really 256, but >128 could damage the LCD
 
                 case Model_iPAQ_H38xx:
                 case Model_iPAQ_H39xx:
                         return 64;
                 case Model_iPAQ_H5xxx:
                         return 255;
 
                 default:
                         return 2;
         }
 }
 
 
 bool iPAQ::hasLightSensor ( ) const
 {
         return true;
 }
 
 int iPAQ::readLightSensor ( )
 {
         int fd;
         int val = -1;
 
         if (( fd = ::open ( "/proc/hal/light_sensor", O_RDONLY )) >= 0 ) {
                 char buffer [8];
 
                 if ( ::read ( fd, buffer, 5 ) == 5 ) {
                         char *endptr;
 
                         buffer [4] = 0;
                         val = ::strtol ( buffer + 2, &endptr, 16 );
 
                         if ( *endptr != 0 )
                                 val = -1;
                 }
                 ::close ( fd );
         }
 
         return val;
 }
 
 int iPAQ::lightSensorResolution ( ) const
 {
         return 256;
 }
 
 /**************************************************
  *
  * Zaurus
  *
  **************************************************/
 
 // Check whether this device is the sharp zaurus..
+// FIXME This gets unnecessary complicated. We should think about splitting the Zaurus
+//       class up into individual classes. We need three classes
+//
+//       Zaurus-Collie (SA-model  w/ 320x240 lcd, for SL5500 and SL5000)
+//       Zaurus-Poodle (PXA-model w/ 320x240 lcd, for SL5600)
+//       Zaurus-Corgi  (PXA-model w/ 640x480 lcd, for C700, C750, C760, and C860)
+//
+//       Only question right now is: Do we really need to do it? Because as soon
+//       as the OpenZaurus kernel is ready, there will be a unified interface for all
+//       Zaurus models (concerning apm, backlight, buttons, etc.)
+//
+//       Comments? - mickeyl.
+
 bool Zaurus::isZaurus()
 {
 
         // If the special devices by embedix exist, it is quite simple: it is a Zaurus !
         if ( QFile::exists ( "/dev/sharp_buz" ) || QFile::exists ( "/dev/sharp_led" ) ){
                 return true;
                 }
 
         // On non-embedix kernels, we have to look closer.
         bool is_zaurus = false;
         QFile f ( "/proc/cpuinfo" );
         if ( f. open ( IO_ReadOnly ) ) {
                 QString model;
                 QFile f ( "/proc/cpuinfo" );
 
                 QTextStream ts ( &f );
                 QString line;
                 while( line = ts. readLine ( ) ) {
                         if ( line. left ( 8 ) == "Hardware" )
                                 break;
                 }
                 int loc = line. find ( ":" );
                 if ( loc != -1 )
                         model = line. mid ( loc + 2 ). simplifyWhiteSpace( );
 
                 if ( model == "Sharp-Collie" 
                      || model == "Collie" 
                      || model == "SHARP Corgi"
                      || model == "SHARP Shepherd" 
                      || model == "SHARP Poodle" 
                      || model == "SHARP Husky"
                    )
                         is_zaurus = true;
 
           }
         return is_zaurus;
 }
 
 
 void Zaurus::init ( )
 {
         d-> m_vendorstr = "Sharp";
         d-> m_vendor = Vendor_Sharp;
         m_embedix = true;  // Not openzaurus means: It has an embedix kernel !
 
         // QFile f ( "/proc/filesystems" );
         QString model;
 
         // It isn't a good idea to check the system configuration to 
         // detect the distribution ! 
         // Otherwise it may happen that any other distribution is detected as openzaurus, just
         // because it uses a jffs2 filesystem..  
         // (eilers)
         // if ( f. open ( IO_ReadOnly ) && ( QTextStream ( &f ). read ( ). find ( "\tjffs2\n" ) >= 0 )) {
         QFile f ("/etc/oz_version");
         if ( f.exists() ){
                 d-> m_vendorstr = "OpenZaurus Team";
                 d-> m_systemstr = "OpenZaurus";
                 d-> m_system = System_OpenZaurus;
 
                 if ( f. open ( IO_ReadOnly )) {
                         QTextStream ts ( &f );
                         d-> m_sysverstr = ts. readLine ( );//. mid ( 10 );
                         f. close ( );
                 }
 
                 // Openzaurus sometimes uses the embedix kernel!
                 // => Check whether this is an embedix kernel
                 FILE *uname = popen("uname -r", "r");
                 QString line;
                 if ( f.open(IO_ReadOnly, uname) ) {
                         QTextStream ts ( &f );
                         line = ts. readLine ( );
                         int loc = line. find ( "embedix" );
                         if ( loc != -1 )
                                 m_embedix = true;
                         else
                                 m_embedix = false;
                         f. close ( );
                 }
                 pclose(uname);
         }
         else {
                 d-> m_systemstr = "Zaurus";
                 d-> m_system = System_Zaurus;
         }
 
         f. setName ( "/proc/cpuinfo" );
         if ( f. open ( IO_ReadOnly ) ) {
                 QTextStream ts ( &f );
                 QString line;
                 while( line = ts. readLine ( ) ) {
                         if ( line. left ( 8 ) == "Hardware" )
                                 break;
                 }
                 int loc = line. find ( ":" );
                 if ( loc != -1 )
                         model = line. mid ( loc + 2 ). simplifyWhiteSpace( );
         }
 
         if ( model == "SHARP Corgi" ) {
                 d-> m_model = Model_Zaurus_SLC7x0;
                 d-> m_modelstr = "Zaurus SL-C700";
         } else if ( model == "SHARP Shepherd" ) {
                 d-> m_model = Model_Zaurus_SLC7x0;
                 d-> m_modelstr = "Zaurus SL-C750";
         } else if ( model == "SHARP Husky" ) {
                 d-> m_model = Model_Zaurus_SLC7x0;
                 d-> m_modelstr = "Zaurus SL-C760";
         } else if ( model == "SHARP Poodle" ) {
                 d-> m_model = Model_Zaurus_SLB600;
                 d-> m_modelstr = "Zaurus SL-B500 or SL-5600";
         } else if ( model == "Sharp-Collie" || model == "Collie" ) {
                 d-> m_model = Model_Zaurus_SL5500;
                 d-> m_modelstr = "Zaurus SL-5500 or SL-5000d";
         } else {
                 d-> m_model = Model_Zaurus_SL5500;
                 d-> m_modelstr = "Zaurus (Model unknown)";
         }
 
         bool flipstate = false;
         switch ( d-> m_model ) {
                 case Model_Zaurus_SLA300:
                         d-> m_rotation = Rot0;
                         break;
                 case Model_Zaurus_SLC7x0:
                         // Note: need to 1) set flipstate based on physical screen orientation
                         // and 2) check to see if the user overrode the rotation direction
                         // using appearance, and if so, remove that item from the Config to
                         // ensure the rotate applet flips us back to the previous state.
+                        // treke said he has patches for detecting the phys. so where are they, treke? -mickeyl.
                         if ( flipstate ) {
                                 // 480x640
                                 d-> m_rotation = Rot0;
                                 d-> m_direction = CW;
                         } else {
                                 // 640x480
                                 d-> m_rotation = Rot270;
                                 d-> m_direction = CCW;
                         }
                         break;
                 case Model_Zaurus_SLB600:
                 case Model_Zaurus_SL5500:
                 case Model_Zaurus_SL5000:
                 default:
                         d-> m_rotation = Rot270;
                         break;
         }
         m_leds [0] = Led_Off;
 }
 
 void Zaurus::initButtons ( )
 {
         if ( d-> m_buttons )
                 return;
 
         d-> m_buttons = new QValueList <ODeviceButton>;
 
         struct z_button * pz_buttons;
         int buttoncount;
         switch ( d-> m_model ) {
                 case Model_Zaurus_SLC7x0:
                         pz_buttons = z_buttons_c700;
                         buttoncount = ARRAY_SIZE(z_buttons_c700);
                         break;
                 default:
                         pz_buttons = z_buttons;
                         buttoncount = ARRAY_SIZE(z_buttons);
                         break;
         }
 
         for ( int i = 0; i < buttoncount; i++ ) {
                 struct z_button *zb = pz_buttons + i;
                 ODeviceButton b;
 
                 b. setKeycode ( zb-> code );
                 b. setUserText ( QObject::tr ( "Button", zb-> utext ));
                 b. setPixmap ( Resource::loadPixmap ( zb-> pix ));
                 b. setFactoryPresetPressedAction ( OQCopMessage ( makeChannel ( zb-> fpressedservice ), 
                                                                   zb-> fpressedaction ));
                 b. setFactoryPresetHeldAction ( OQCopMessage ( makeChannel ( zb-> fheldservice ), 
                                                                zb-> fheldaction ));
 
                 d-> m_buttons-> append ( b );
         }
 
         reloadButtonMapping ( );
 
         QCopChannel *sysch = new QCopChannel ( "QPE/System", this );
         connect ( sysch, SIGNAL( received( const QCString &, const QByteArray & )), 
                   this, SLOT( systemMessage ( const QCString &, const QByteArray & )));
 }
 
 #include <unistd.h>
 #include <fcntl.h>
 #include <sys/ioctl.h>
 
 //#include <asm/sharp_char.h> // including kernel headers is evil ...
 
 #define SHARP_DEV_IOCTL_COMMAND_START 0x5680
 
         #defineSHARP_BUZZER_IOCTL_START (SHARP_DEV_IOCTL_COMMAND_START)
 #define SHARP_BUZZER_MAKESOUND   (SHARP_BUZZER_IOCTL_START)
 
 #define SHARP_BUZ_TOUCHSOUND       1  /* touch panel sound */
 #define SHARP_BUZ_KEYSOUND         2  /* key sound */
 #define SHARP_BUZ_SCHEDULE_ALARM  11  /* schedule alarm */
 
 /* --- for SHARP_BUZZER device --- */
 
         //#defineSHARP_BUZZER_IOCTL_START (SHARP_DEV_IOCTL_COMMAND_START)
 //#define SHARP_BUZZER_MAKESOUND   (SHARP_BUZZER_IOCTL_START)
 
 #define SHARP_BUZZER_SETVOLUME   (SHARP_BUZZER_IOCTL_START+1)
 #define SHARP_BUZZER_GETVOLUME   (SHARP_BUZZER_IOCTL_START+2)
 #define SHARP_BUZZER_ISSUPPORTED (SHARP_BUZZER_IOCTL_START+3)
 #define SHARP_BUZZER_SETMUTE     (SHARP_BUZZER_IOCTL_START+4)
 #define SHARP_BUZZER_STOPSOUND   (SHARP_BUZZER_IOCTL_START+5)
 
 //#define SHARP_BUZ_TOUCHSOUND       1  /* touch panel sound */
 //#define SHARP_BUZ_KEYSOUND         2  /* key sound */
 
 //#define SHARP_PDA_ILLCLICKSOUND    3  /* illegal click */
 //#define SHARP_PDA_WARNSOUND        4  /* warning occurred */
 //#define SHARP_PDA_ERRORSOUND       5  /* error occurred */
 //#define SHARP_PDA_CRITICALSOUND    6  /* critical error occurred */
 //#define SHARP_PDA_SYSSTARTSOUND    7  /* system start */
 //#define SHARP_PDA_SYSTEMENDSOUND   8  /* system shutdown */
 //#define SHARP_PDA_APPSTART         9  /* application start */
 //#define SHARP_PDA_APPQUIT         10  /* application ends */
 
 //#define SHARP_BUZ_SCHEDULE_ALARM  11  /* schedule alarm */
 //#define SHARP_BUZ_DAILY_ALARM     12  /* daily alarm */
 //#define SHARP_BUZ_GOT_PHONE_CALL  13  /* phone call sound */
 //#define SHARP_BUZ_GOT_MAIL        14  /* mail sound */
 //
 
         #defineSHARP_LED_IOCTL_START (SHARP_DEV_IOCTL_COMMAND_START)
 #define SHARP_LED_SETSTATUS   (SHARP_LED_IOCTL_START+1)
 
 typedef struct sharp_led_status {
   int which;   /* select which LED status is wanted. */
   int status;  /* set new led status if you call SHARP_LED_SETSTATUS */
 } sharp_led_status;
 
 #define SHARP_LED_MAIL_EXISTS  9       /* mail status (exists or not) */
 
 #define LED_MAIL_NO_UNREAD_MAIL  0   /* for SHARP_LED_MAIL_EXISTS */
 #define LED_MAIL_NEWMAIL_EXISTS  1   /* for SHARP_LED_MAIL_EXISTS */
 #define LED_MAIL_UNREAD_MAIL_EX  2   /* for SHARP_LED_MAIL_EXISTS */
 
 // #include <asm/sharp_apm.h> // including kernel headers is evil ...
 
 #define APM_IOCGEVTSRC          OD_IOR( 'A', 203, int )
 #define APM_IOCSEVTSRC          OD_IORW( 'A', 204, int )
 #define APM_EVT_POWER_BUTTON    (1 << 0)
 
 #define FL_IOCTL_STEP_CONTRAST    100
 
@@ -1811,256 +1825,259 @@ void Zaurus::buzzer ( int sound )
                 if ( fd >= 0 ) {
                         if ( vol_reset )
                                 ::ioctl ( fd, MIXER_WRITE( 0 ), &vol );
                         ::close ( fd );
                 }
                 } else {        
                 int fd = ::open ( "/dev/sharp_buz", O_WRONLY|O_NONBLOCK );
                 
                 if ( fd >= 0 ) {
                         ::ioctl ( fd, SHARP_BUZZER_MAKESOUND, sound );
                         ::close ( fd );
                 }
 
         } 
 #endif
 }
 
 
 void Zaurus::alarmSound ( )
 {
         buzzer ( SHARP_BUZ_SCHEDULE_ALARM );
 }
 
 void Zaurus::touchSound ( )
 {
         buzzer ( SHARP_BUZ_TOUCHSOUND );
 }
 
 void Zaurus::keySound ( )
 {
         buzzer ( SHARP_BUZ_KEYSOUND );
 }
 
 
 QValueList <OLed> Zaurus::ledList ( ) const
 {
         QValueList <OLed> vl;
         vl << Led_Mail;
         return vl;
 }
 
 QValueList <OLedState> Zaurus::ledStateList ( OLed l ) const
 {
         QValueList <OLedState> vl;
 
         if ( l == Led_Mail )
                 vl << Led_Off << Led_On << Led_BlinkSlow;
         return vl;
 }
 
 OLedState Zaurus::ledState ( OLed which ) const
 {
         if ( which == Led_Mail )
                 return m_leds [0];
         else
                 return Led_Off;
 }
 
 bool Zaurus::setLedState ( OLed which, OLedState st )
 {
         if (!m_embedix) // Currently not supported on non_embedix kernels
                 return false;
 
         static int fd = ::open ( "/dev/sharp_led", O_RDWR|O_NONBLOCK );
 
         if ( which == Led_Mail ) {
                 if ( fd >= 0 ) {
                         struct sharp_led_status leds;
                         ::memset ( &leds, 0, sizeof( leds ));
                         leds. which = SHARP_LED_MAIL_EXISTS;
                         bool ok = true;
 
                         switch ( st ) {
                                 case Led_Off      : leds. status = LED_MAIL_NO_UNREAD_MAIL; break;
                                 case Led_On       : leds. status = LED_MAIL_NEWMAIL_EXISTS; break;
                                 case Led_BlinkSlow: leds. status = LED_MAIL_UNREAD_MAIL_EX; break;
                                 default            : ok = false;
                         }
 
                         if ( ok && ( ::ioctl ( fd, SHARP_LED_SETSTATUS, &leds ) >= 0 )) {
                                 m_leds [0] = st;
                                 return true;
                         }
                 }
         }
         return false;
 }
 
 bool Zaurus::setSoftSuspend ( bool soft )
 {
         if (!m_embedix) {
                 /* non-Embedix kernels dont have kernel autosuspend */
                 return ODevice::setSoftSuspend( soft );
         }
 
         bool res = false;
         int fd;
 
         if ((( fd = ::open ( "/dev/apm_bios", O_RDWR )) >= 0 ) ||
         (( fd = ::open ( "/dev/misc/apm_bios",O_RDWR )) >= 0 )) {
 
                 int sources = ::ioctl ( fd, APM_IOCGEVTSRC, 0 ); // get current event sources
 
                 if ( sources >= 0 ) {
                         if ( soft )
                                 sources &= ~APM_EVT_POWER_BUTTON;
                         else
                                 sources |= APM_EVT_POWER_BUTTON;
 
                         if ( ::ioctl ( fd, APM_IOCSEVTSRC, sources ) >= 0 ) // set new event sources
                                 res = true;
                         else
                                 perror ( "APM_IOCGEVTSRC" );
                 }
                 else
                         perror ( "APM_IOCGEVTSRC" );
 
                 ::close ( fd );
         }
         else
                 perror ( "/dev/apm_bios or /dev/misc/apm_bios" );
 
     return res;
 }
 
 
 bool Zaurus::setDisplayBrightness ( int bright )
 {
+// FIXME The C7x0 have a proc-interface (/proc/drivers/corgi-bl) which
+//       is nice to use. Currently it exposes 16+1 levels. Implement this!
+//       (or wait for kergoth unifying the interfaces in the OpenZaurus kernel.)
         bool res = false;
         int fd;
 
         if ( bright > 255 )
                 bright = 255;
         if ( bright < 0 )
                 bright = 0;
 
         if (m_embedix) {
                 if (( fd = ::open ( "/dev/fl", O_WRONLY )) >= 0 ) {
                         int bl = ( bright * 4 + 127 ) / 255; // only 4 steps on zaurus
                         if ( bright && !bl )
                                 bl = 1;
                         res = ( ::ioctl ( fd, FL_IOCTL_STEP_CONTRAST, bl ) == 0 );
                         ::close ( fd );
                 }
         } else {
 #define FB_BACKLIGHT_SET_BRIGHTNESS     _IOW('F', 1, u_int)             /* set brightness */
                 if (( fd = ::open ( "/dev/fb0", O_WRONLY )) >= 0 ) {
                         res = ( ::ioctl ( fd , FB_BACKLIGHT_SET_BRIGHTNESS, bright ) == 0 );
                         ::close ( fd );
                 }
         }
         return res;
 }
 
 
 int Zaurus::displayBrightnessResolution ( ) const
 {
         if (m_embedix)
                 return 5;
         else
                 return 256;
 }
 
 /**************************************************
  *
  * SIMpad
  *
  **************************************************/
 
 void SIMpad::init ( )
 {
         d-> m_vendorstr = "SIEMENS";
         d-> m_vendor = Vendor_SIEMENS;
 
         QFile f ( "/proc/hal/model" );
 
     //TODO Implement model checking
     //FIXME For now we assume an SL4
 
     d-> m_modelstr = "SL4";
     d-> m_model = Model_SIMpad_SL4;
 
         switch ( d-> m_model ) {
                 default:
                         d-> m_rotation = Rot0;
                         d-> m_direction = CCW;
                         d-> m_holdtime = 1000; // 1000ms
 
                         break;
         }
 
         f. setName ( "/etc/familiar-version" );
         if ( f. open ( IO_ReadOnly )) {
                 d-> m_systemstr = "Familiar";
                 d-> m_system = System_Familiar;
 
                 QTextStream ts ( &f );
                 d-> m_sysverstr = ts. readLine ( ). mid ( 10 );
 
                 f. close ( );
         } else {
             f. setName ( "/etc/oz_version" );
 
                     if ( f. open ( IO_ReadOnly )) {
                     d-> m_systemstr = "OpenEmbedded/SIMpad";
                 d-> m_system = System_OpenZaurus;
 
                     QTextStream ts ( &f );
                     ts.setDevice ( &f );
                     d-> m_sysverstr = ts. readLine ( );
                     f. close ( );
         }
     }
 
         m_leds [0] = m_leds [1] = Led_Off;
 
         m_power_timer = 0;
 
 }
 
 void SIMpad::initButtons ( )
 {
         if ( d-> m_buttons )
                 return;
 
         if ( isQWS( ) )
                 QWSServer::setKeyboardFilter ( this );
 
         d-> m_buttons = new QValueList <ODeviceButton>;
 
         for ( uint i = 0; i < ( sizeof( simpad_buttons ) / sizeof( s_button )); i++ ) {
                 s_button *sb = simpad_buttons + i;
                 ODeviceButton b;
 
                 if (( sb-> model & d-> m_model ) == d-> m_model ) {
                         b. setKeycode ( sb-> code );
                         b. setUserText ( QObject::tr ( "Button", sb-> utext ));
                         b. setPixmap ( Resource::loadPixmap ( sb-> pix ));
                         b. setFactoryPresetPressedAction ( OQCopMessage ( makeChannel ( sb-> fpressedservice ), sb-> fpressedaction ));
                         b. setFactoryPresetHeldAction ( OQCopMessage ( makeChannel ( sb-> fheldservice ), sb-> fheldaction ));
 
                         d-> m_buttons-> append ( b );
                 }
         }
         reloadButtonMapping ( );
 
         QCopChannel *sysch = new QCopChannel ( "QPE/System", this );
         connect ( sysch, SIGNAL( received( const QCString &, const QByteArray & )), this, SLOT( systemMessage ( const QCString &, const QByteArray & )));
 }
 
 // SIMpad boardcontrol register CS3
 #define SIMPAD_BOARDCONTROL "/proc/cs3"
 #define SIMPAD_VCC_5V_EN                   0x0001 // For 5V PCMCIA
 #define SIMPAD_VCC_3V_EN                   0x0002 // FOR 3.3V PCMCIA
 #define SIMPAD_EN1                         0x0004 // This is only for EPROM's
 #define SIMPAD_EN0                         0x0008 // Both should be enable for 3.3V or 5V