1 /*********************************************************************
 
   5  * Description:   Implementation of the MA600 dongle
 
   6  * Status:        Experimental.
 
   7  * Author:        Leung <95Etwl@alumni.ee.ust.hk> http://www.engsvr.ust/~eetwl95
 
   8  * Created at:    Sat Jun 10 20:02:35 2000
 
   9  * Modified at:   Sat Aug 16 09:34:13 2003
 
  10  * Modified by:   Martin Diehl <mad@mdiehl.de> (modified for new sir_dev)
 
  12  * Note: very thanks to Mr. Maru Wang <maru@mobileaction.com.tw> for providing 
 
  13  *       information on the MA600 dongle
 
  15  *     Copyright (c) 2000 Leung, All Rights Reserved.
 
  17  *     This program is free software; you can redistribute it and/or 
 
  18  *     modify it under the terms of the GNU General Public License as 
 
  19  *     published by the Free Software Foundation; either version 2 of 
 
  20  *     the License, or (at your option) any later version.
 
  22  *     This program is distributed in the hope that it will be useful,
 
  23  *     but WITHOUT ANY WARRANTY; without even the implied warranty of
 
  24  *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 
  25  *     GNU General Public License for more details.
 
  27  *     You should have received a copy of the GNU General Public License 
 
  28  *     along with this program; if not, write to the Free Software 
 
  29  *     Foundation, Inc., 59 Temple Place, Suite 330, Boston, 
 
  32  ********************************************************************/
 
  34 #include <linux/module.h>
 
  35 #include <linux/delay.h>
 
  36 #include <linux/init.h>
 
  38 #include <net/irda/irda.h>
 
  42 static int ma600_open(struct sir_dev *);
 
  43 static int ma600_close(struct sir_dev *);
 
  44 static int ma600_change_speed(struct sir_dev *, unsigned);
 
  45 static int ma600_reset(struct sir_dev *);
 
  47 /* control byte for MA600 */
 
  48 #define MA600_9600      0x00
 
  49 #define MA600_19200     0x01
 
  50 #define MA600_38400     0x02
 
  51 #define MA600_57600     0x03
 
  52 #define MA600_115200    0x04
 
  53 #define MA600_DEV_ID1   0x05
 
  54 #define MA600_DEV_ID2   0x06
 
  55 #define MA600_2400      0x08
 
  57 static struct dongle_driver ma600 = {
 
  59         .driver_name    = "MA600",
 
  60         .type           = IRDA_MA600_DONGLE,
 
  64         .set_speed      = ma600_change_speed,
 
  68 static int __init ma600_sir_init(void)
 
  70         IRDA_DEBUG(2, "%s()\n", __FUNCTION__);
 
  71         return irda_register_dongle(&ma600);
 
  74 static void __exit ma600_sir_cleanup(void)
 
  76         IRDA_DEBUG(2, "%s()\n", __FUNCTION__);
 
  77         irda_unregister_dongle(&ma600);
 
  82                 (0) Clear RTS and DTR for 1 second
 
  83                 (1) Set RTS and DTR for 1 second
 
  85         Note: assume RTS, DTR are clear before
 
  87 static int ma600_open(struct sir_dev *dev)
 
  89         struct qos_info *qos = &dev->qos;
 
  91         IRDA_DEBUG(2, "%s()\n", __FUNCTION__);
 
  93         sirdev_set_dtr_rts(dev, TRUE, TRUE);
 
  95         /* Explicitly set the speeds we can accept */
 
  96         qos->baud_rate.bits &= IR_2400|IR_9600|IR_19200|IR_38400
 
  98         /* Hm, 0x01 means 10ms - for >= 1ms we would need 0x07 */
 
  99         qos->min_turn_time.bits = 0x01;         /* Needs at least 1 ms */       
 
 100         irda_qos_bits_to_value(qos);
 
 102         /* irda thread waits 50 msec for power settling */
 
 107 static int ma600_close(struct sir_dev *dev)
 
 109         IRDA_DEBUG(2, "%s()\n", __FUNCTION__);
 
 111         /* Power off dongle */
 
 112         sirdev_set_dtr_rts(dev, FALSE, FALSE);
 
 117 static __u8 get_control_byte(__u32 speed)
 
 147  * Function ma600_change_speed (dev, speed)
 
 149  *    Set the speed for the MA600 type dongle.
 
 151  *    The dongle has already been reset to a known state (dongle default)
 
 152  *    We cycle through speeds by pulsing RTS low and then high.
 
 156  * Function ma600_change_speed (dev, speed)
 
 158  *    Set the speed for the MA600 type dongle.
 
 161  *    1. Reset (already done by irda thread state machine)
 
 162  *    2. clear RTS, set DTR and wait for 1ms
 
 163  *    3. send Control Byte to the MA600 through TXD to set new baud rate
 
 164  *       wait until the stop bit of Control Byte is sent (for 9600 baud rate, 
 
 165  *       it takes about 10 msec)
 
 166  *    4. set RTS, set DTR (return to NORMAL Operation)
 
 167  *    5. wait at least 10 ms, new setting (baud rate, etc) takes effect here 
 
 171 /* total delays are only about 20ms - let's just sleep for now to
 
 172  * avoid the state machine complexity before we get things working
 
 175 static int ma600_change_speed(struct sir_dev *dev, unsigned speed)
 
 179         IRDA_DEBUG(2, "%s(), speed=%d (was %d)\n", __FUNCTION__,
 
 182         /* dongle already reset, dongle and port at default speed (9600) */
 
 184         /* Set RTS low for 1 ms */
 
 185         sirdev_set_dtr_rts(dev, TRUE, FALSE);
 
 188         /* Write control byte */
 
 189         byte = get_control_byte(speed);
 
 190         sirdev_raw_write(dev, &byte, sizeof(byte));
 
 192         /* Wait at least 10ms: fake wait_until_sent - 10 bits at 9600 baud*/
 
 193         msleep(15);                                     /* old ma600 uses 15ms */
 
 196         /* read-back of the control byte. ma600 is the first dongle driver
 
 197          * which uses this so there might be some unidentified issues.
 
 198          * Disable this in case of problems with readback.
 
 201         sirdev_raw_read(dev, &byte, sizeof(byte));
 
 202         if (byte != get_control_byte(speed))  {
 
 203                 IRDA_WARNING("%s(): bad control byte read-back %02x != %02x\n",
 
 204                              __FUNCTION__, (unsigned) byte,
 
 205                              (unsigned) get_control_byte(speed));
 
 209                 IRDA_DEBUG(2, "%s() control byte write read OK\n", __FUNCTION__);
 
 212         /* Set DTR, Set RTS */
 
 213         sirdev_set_dtr_rts(dev, TRUE, TRUE);
 
 215         /* Wait at least 10ms */
 
 218         /* dongle is now switched to the new speed */
 
 225  * Function ma600_reset (dev)
 
 227  *      This function resets the ma600 dongle.
 
 230  *        0. DTR=0, RTS=1 and wait 10 ms
 
 231  *        1. DTR=1, RTS=1 and wait 10 ms
 
 235 /* total delays are only about 20ms - let's just sleep for now to
 
 236  * avoid the state machine complexity before we get things working
 
 239 int ma600_reset(struct sir_dev *dev)
 
 241         IRDA_DEBUG(2, "%s()\n", __FUNCTION__);
 
 243         /* Reset the dongle : set DTR low for 10 ms */
 
 244         sirdev_set_dtr_rts(dev, FALSE, TRUE);
 
 247         /* Go back to normal mode */
 
 248         sirdev_set_dtr_rts(dev, TRUE, TRUE);
 
 251         dev->speed = 9600;      /* That's the dongle-default */
 
 256 MODULE_AUTHOR("Leung <95Etwl@alumni.ee.ust.hk> http://www.engsvr.ust/~eetwl95");
 
 257 MODULE_DESCRIPTION("MA600 dongle driver version 0.1");
 
 258 MODULE_LICENSE("GPL");
 
 259 MODULE_ALIAS("irda-dongle-11"); /* IRDA_MA600_DONGLE */
 
 261 module_init(ma600_sir_init);
 
 262 module_exit(ma600_sir_cleanup);