baycom_par.c
上传用户:lgb322
上传日期:2013-02-24
资源大小:30529k
文件大小:17k
源码类别:

嵌入式Linux

开发平台:

Unix_Linux

  1. /*****************************************************************************/
  2. /*
  3.  * baycom_par.c  -- baycom par96 and picpar radio modem driver.
  4.  *
  5.  * Copyright (C) 1996-2000  Thomas Sailer (sailer@ife.ee.ethz.ch)
  6.  *
  7.  * This program is free software; you can redistribute it and/or modify
  8.  * it under the terms of the GNU General Public License as published by
  9.  * the Free Software Foundation; either version 2 of the License, or
  10.  * (at your option) any later version.
  11.  *
  12.  * This program is distributed in the hope that it will be useful,
  13.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15.  * GNU General Public License for more details.
  16.  *
  17.  * You should have received a copy of the GNU General Public License
  18.  * along with this program; if not, write to the Free Software
  19.  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20.  *
  21.  *  Please note that the GPL allows you to use the driver, NOT the radio.
  22.  *  In order to use the radio, you need a license from the communications
  23.  *  authority of your country.
  24.  *
  25.  *
  26.  *  Supported modems
  27.  *
  28.  *  par96:  This is a modem for 9600 baud FSK compatible to the G3RUH standard.
  29.  *          The modem does all the filtering and regenerates the receiver clock.
  30.  *          Data is transferred from and to the PC via a shift register.
  31.  *          The shift register is filled with 16 bits and an interrupt is
  32.  *          signalled. The PC then empties the shift register in a burst. This
  33.  *          modem connects to the parallel port, hence the name. The modem
  34.  *          leaves the implementation of the HDLC protocol and the scrambler
  35.  *          polynomial to the PC. This modem is no longer available (at least
  36.  *          from Baycom) and has been replaced by the PICPAR modem (see below).
  37.  *          You may however still build one from the schematics published in
  38.  *          cq-DL :-).
  39.  *
  40.  *  picpar: This is a redesign of the par96 modem by Henning Rech, DF9IC. The
  41.  *          modem is protocol compatible to par96, but uses only three low
  42.  *          power ICs and can therefore be fed from the parallel port and
  43.  *          does not require an additional power supply. It features
  44.  *          built in DCD circuitry. The driver should therefore be configured
  45.  *          for hardware DCD.
  46.  *
  47.  *
  48.  *  Command line options (insmod command line)
  49.  *
  50.  *  mode     driver mode string. Valid choices are par96 and picpar.
  51.  *  iobase   base address of the port; common values are 0x378, 0x278, 0x3bc
  52.  *
  53.  *
  54.  *  History:
  55.  *   0.1  26.06.1996  Adapted from baycom.c and made network driver interface
  56.  *        18.10.1996  Changed to new user space access routines (copy_{to,from}_user)
  57.  *   0.3  26.04.1997  init code/data tagged
  58.  *   0.4  08.07.1997  alternative ser12 decoding algorithm (uses delta CTS ints)
  59.  *   0.5  11.11.1997  split into separate files for ser12/par96
  60.  *   0.6  03.08.1999  adapt to Linus' new __setup/__initcall
  61.  *                    removed some pre-2.2 kernel compatibility cruft
  62.  *   0.7  10.08.1999  Check if parport can do SPP and is safe to access during interrupt contexts
  63.  *   0.8  12.02.2000  adapted to softnet driver interface
  64.  *                    removed direct parport access, uses parport driver methods
  65.  *   0.9  03.07.2000  fix interface name handling
  66.  */
  67. /*****************************************************************************/
  68. #include <linux/version.h>
  69. #include <linux/module.h>
  70. #include <linux/kernel.h>
  71. #include <linux/sched.h>
  72. #include <linux/types.h>
  73. #include <linux/fcntl.h>
  74. #include <linux/interrupt.h>
  75. #include <linux/ioport.h>
  76. #include <linux/in.h>
  77. #include <linux/string.h>
  78. #include <asm/system.h>
  79. #include <asm/bitops.h>
  80. #include <asm/uaccess.h>
  81. #include <linux/init.h>
  82. #include <linux/delay.h>
  83. #include <linux/errno.h>
  84. #include <linux/netdevice.h>
  85. #include <linux/hdlcdrv.h>
  86. #include <linux/baycom.h>
  87. #include <linux/parport.h>
  88. /* --------------------------------------------------------------------- */
  89. #define BAYCOM_DEBUG
  90. /*
  91.  * modem options; bit mask
  92.  */
  93. #define BAYCOM_OPTIONS_SOFTDCD  1
  94. /* --------------------------------------------------------------------- */
  95. static const char bc_drvname[] = "baycom_par";
  96. static const char bc_drvinfo[] = KERN_INFO "baycom_par: (C) 1996-2000 Thomas Sailer, HB9JNX/AE4WAn"
  97. KERN_INFO "baycom_par: version 0.9 compiled " __TIME__ " " __DATE__ "n";
  98. /* --------------------------------------------------------------------- */
  99. #define NR_PORTS 4
  100. static struct net_device baycom_device[NR_PORTS];
  101. /* --------------------------------------------------------------------- */
  102. #define PAR96_BURSTBITS 16
  103. #define PAR96_BURST     4
  104. #define PAR96_PTT       2
  105. #define PAR96_TXBIT     1
  106. #define PAR96_ACK       0x40
  107. #define PAR96_RXBIT     0x20
  108. #define PAR96_DCD       0x10
  109. #define PAR97_POWER     0xf8
  110. /* ---------------------------------------------------------------------- */
  111. /*
  112.  * Information that need to be kept for each board.
  113.  */
  114. struct baycom_state {
  115. struct hdlcdrv_state hdrv;
  116. struct pardevice *pdev;
  117. unsigned int options;
  118. struct modem_state {
  119. short arb_divider;
  120. unsigned char flags;
  121. unsigned int shreg;
  122. struct modem_state_par96 {
  123. int dcd_count;
  124. unsigned int dcd_shreg;
  125. unsigned long descram;
  126. unsigned long scram;
  127. } par96;
  128. } modem;
  129. #ifdef BAYCOM_DEBUG
  130. struct debug_vals {
  131. unsigned long last_jiffies;
  132. unsigned cur_intcnt;
  133. unsigned last_intcnt;
  134. int cur_pllcorr;
  135. int last_pllcorr;
  136. } debug_vals;
  137. #endif /* BAYCOM_DEBUG */
  138. };
  139. /* --------------------------------------------------------------------- */
  140. static void __inline__ baycom_int_freq(struct baycom_state *bc)
  141. {
  142. #ifdef BAYCOM_DEBUG
  143. unsigned long cur_jiffies = jiffies;
  144. /*
  145.  * measure the interrupt frequency
  146.  */
  147. bc->debug_vals.cur_intcnt++;
  148. if ((cur_jiffies - bc->debug_vals.last_jiffies) >= HZ) {
  149. bc->debug_vals.last_jiffies = cur_jiffies;
  150. bc->debug_vals.last_intcnt = bc->debug_vals.cur_intcnt;
  151. bc->debug_vals.cur_intcnt = 0;
  152. bc->debug_vals.last_pllcorr = bc->debug_vals.cur_pllcorr;
  153. bc->debug_vals.cur_pllcorr = 0;
  154. }
  155. #endif /* BAYCOM_DEBUG */
  156. }
  157. /* --------------------------------------------------------------------- */
  158. /*
  159.  * ===================== PAR96 specific routines =========================
  160.  */
  161. #define PAR96_DESCRAM_TAP1 0x20000
  162. #define PAR96_DESCRAM_TAP2 0x01000
  163. #define PAR96_DESCRAM_TAP3 0x00001
  164. #define PAR96_DESCRAM_TAPSH1 17
  165. #define PAR96_DESCRAM_TAPSH2 12
  166. #define PAR96_DESCRAM_TAPSH3 0
  167. #define PAR96_SCRAM_TAP1 0x20000 /* X^17 */
  168. #define PAR96_SCRAM_TAPN 0x00021 /* X^0+X^5 */
  169. /* --------------------------------------------------------------------- */
  170. static __inline__ void par96_tx(struct net_device *dev, struct baycom_state *bc)
  171. {
  172. int i;
  173. unsigned int data = hdlcdrv_getbits(&bc->hdrv);
  174. struct parport *pp = bc->pdev->port;
  175. for(i = 0; i < PAR96_BURSTBITS; i++, data >>= 1) {
  176. unsigned char val = PAR97_POWER;
  177. bc->modem.par96.scram = ((bc->modem.par96.scram << 1) |
  178.  (bc->modem.par96.scram & 1));
  179. if (!(data & 1))
  180. bc->modem.par96.scram ^= 1;
  181. if (bc->modem.par96.scram & (PAR96_SCRAM_TAP1 << 1))
  182. bc->modem.par96.scram ^=
  183. (PAR96_SCRAM_TAPN << 1);
  184. if (bc->modem.par96.scram & (PAR96_SCRAM_TAP1 << 2))
  185. val |= PAR96_TXBIT;
  186. pp->ops->write_data(pp, val);
  187. pp->ops->write_data(pp, val | PAR96_BURST);
  188. }
  189. }
  190. /* --------------------------------------------------------------------- */
  191. static __inline__ void par96_rx(struct net_device *dev, struct baycom_state *bc)
  192. {
  193. int i;
  194. unsigned int data, mask, mask2, descx;
  195. struct parport *pp = bc->pdev->port;
  196. /*
  197.  * do receiver; differential decode and descramble on the fly
  198.  */
  199. for(data = i = 0; i < PAR96_BURSTBITS; i++) {
  200. bc->modem.par96.descram = (bc->modem.par96.descram << 1);
  201. if (pp->ops->read_status(pp) & PAR96_RXBIT)
  202. bc->modem.par96.descram |= 1;
  203. descx = bc->modem.par96.descram ^
  204. (bc->modem.par96.descram >> 1);
  205. /* now the diff decoded data is inverted in descram */
  206. pp->ops->write_data(pp, PAR97_POWER | PAR96_PTT);
  207. descx ^= ((descx >> PAR96_DESCRAM_TAPSH1) ^
  208.   (descx >> PAR96_DESCRAM_TAPSH2));
  209. data >>= 1;
  210. if (!(descx & 1))
  211. data |= 0x8000;
  212. pp->ops->write_data(pp, PAR97_POWER | PAR96_PTT | PAR96_BURST);
  213. }
  214. hdlcdrv_putbits(&bc->hdrv, data);
  215. /*
  216.  * do DCD algorithm
  217.  */
  218. if (bc->options & BAYCOM_OPTIONS_SOFTDCD) {
  219. bc->modem.par96.dcd_shreg = (bc->modem.par96.dcd_shreg >> 16)
  220. | (data << 16);
  221. /* search for flags and set the dcd counter appropriately */
  222. for(mask = 0x1fe00, mask2 = 0xfc00, i = 0;
  223.     i < PAR96_BURSTBITS; i++, mask <<= 1, mask2 <<= 1)
  224. if ((bc->modem.par96.dcd_shreg & mask) == mask2)
  225. bc->modem.par96.dcd_count = HDLCDRV_MAXFLEN+4;
  226. /* check for abort/noise sequences */
  227. for(mask = 0x1fe00, mask2 = 0x1fe00, i = 0;
  228.     i < PAR96_BURSTBITS; i++, mask <<= 1, mask2 <<= 1)
  229. if (((bc->modem.par96.dcd_shreg & mask) == mask2) &&
  230.     (bc->modem.par96.dcd_count >= 0))
  231. bc->modem.par96.dcd_count -= HDLCDRV_MAXFLEN-10;
  232. /* decrement and set the dcd variable */
  233. if (bc->modem.par96.dcd_count >= 0)
  234. bc->modem.par96.dcd_count -= 2;
  235. hdlcdrv_setdcd(&bc->hdrv, bc->modem.par96.dcd_count > 0);
  236. } else {
  237. hdlcdrv_setdcd(&bc->hdrv, !!(pp->ops->read_status(pp) & PAR96_DCD));
  238. }
  239. }
  240. /* --------------------------------------------------------------------- */
  241. static void par96_interrupt(int irq, void *dev_id, struct pt_regs *regs)
  242. {
  243. struct net_device *dev = (struct net_device *)dev_id;
  244. struct baycom_state *bc = (struct baycom_state *)dev->priv;
  245. if (!dev || !bc || bc->hdrv.magic != HDLCDRV_MAGIC)
  246. return;
  247. baycom_int_freq(bc);
  248. /*
  249.  * check if transmitter active
  250.  */
  251. if (hdlcdrv_ptt(&bc->hdrv))
  252. par96_tx(dev, bc);
  253. else {
  254. par96_rx(dev, bc);
  255. if (--bc->modem.arb_divider <= 0) {
  256. bc->modem.arb_divider = 6;
  257. __sti();
  258. hdlcdrv_arbitrate(dev, &bc->hdrv);
  259. }
  260. }
  261. __sti();
  262. hdlcdrv_transmitter(dev, &bc->hdrv);
  263. hdlcdrv_receiver(dev, &bc->hdrv);
  264.         __cli();
  265. }
  266. /* --------------------------------------------------------------------- */
  267. static void par96_wakeup(void *handle)
  268. {
  269.         struct net_device *dev = (struct net_device *)handle;
  270. struct baycom_state *bc = (struct baycom_state *)dev->priv;
  271. printk(KERN_DEBUG "baycom_par: %s: why am I being woken up?n", dev->name);
  272. if (!parport_claim(bc->pdev))
  273. printk(KERN_DEBUG "baycom_par: %s: I'm broken.n", dev->name);
  274. }
  275. /* --------------------------------------------------------------------- */
  276. static int par96_open(struct net_device *dev)
  277. {
  278. struct baycom_state *bc = (struct baycom_state *)dev->priv;
  279. struct parport *pp = parport_enumerate();
  280. if (!dev || !bc)
  281. return -ENXIO;
  282. while (pp && pp->base != dev->base_addr) 
  283. pp = pp->next;
  284. if (!pp) {
  285. printk(KERN_ERR "baycom_par: parport at 0x%lx unknownn", dev->base_addr);
  286. return -ENXIO;
  287. }
  288. if (pp->irq < 0) {
  289. printk(KERN_ERR "baycom_par: parport at 0x%lx has no irqn", pp->base);
  290. return -ENXIO;
  291. }
  292. if ((~pp->modes) & (PARPORT_MODE_PCSPP | PARPORT_MODE_SAFEININT)) {
  293. printk(KERN_ERR "baycom_par: parport at 0x%lx cannot be usedn", pp->base);
  294. return -ENXIO;
  295. }
  296. memset(&bc->modem, 0, sizeof(bc->modem));
  297. bc->hdrv.par.bitrate = 9600;
  298. if (!(bc->pdev = parport_register_device(pp, dev->name, NULL, par96_wakeup, 
  299.  par96_interrupt, PARPORT_DEV_EXCL, dev))) {
  300. printk(KERN_ERR "baycom_par: cannot register parport at 0x%lxn", pp->base);
  301. return -ENXIO;
  302. }
  303. if (parport_claim(bc->pdev)) {
  304. printk(KERN_ERR "baycom_par: parport at 0x%lx busyn", pp->base);
  305. parport_unregister_device(bc->pdev);
  306. return -EBUSY;
  307. }
  308. pp = bc->pdev->port;
  309. dev->irq = pp->irq;
  310. pp->ops->data_forward(pp);
  311.         bc->hdrv.par.bitrate = 9600;
  312. pp->ops->write_data(pp, PAR96_PTT | PAR97_POWER); /* switch off PTT */
  313. pp->ops->enable_irq(pp);
  314. printk(KERN_INFO "%s: par96 at iobase 0x%lx irq %u options 0x%xn",
  315.        bc_drvname, dev->base_addr, dev->irq, bc->options);
  316. MOD_INC_USE_COUNT;
  317. return 0;
  318. }
  319. /* --------------------------------------------------------------------- */
  320. static int par96_close(struct net_device *dev)
  321. {
  322. struct baycom_state *bc = (struct baycom_state *)dev->priv;
  323. struct parport *pp;
  324. if (!dev || !bc)
  325. return -EINVAL;
  326. pp = bc->pdev->port;
  327. /* disable interrupt */
  328. pp->ops->disable_irq(pp);
  329. /* switch off PTT */
  330. pp->ops->write_data(pp, PAR96_PTT | PAR97_POWER);
  331. parport_release(bc->pdev);
  332. parport_unregister_device(bc->pdev);
  333. printk(KERN_INFO "%s: close par96 at iobase 0x%lx irq %un",
  334.        bc_drvname, dev->base_addr, dev->irq);
  335. MOD_DEC_USE_COUNT;
  336. return 0;
  337. }
  338. /* --------------------------------------------------------------------- */
  339. /*
  340.  * ===================== hdlcdrv driver interface =========================
  341.  */
  342. static int baycom_ioctl(struct net_device *dev, struct ifreq *ifr,
  343. struct hdlcdrv_ioctl *hi, int cmd);
  344. /* --------------------------------------------------------------------- */
  345. static struct hdlcdrv_ops par96_ops = {
  346. bc_drvname,
  347. bc_drvinfo,
  348. par96_open,
  349. par96_close,
  350. baycom_ioctl
  351. };
  352. /* --------------------------------------------------------------------- */
  353. static int baycom_setmode(struct baycom_state *bc, const char *modestr)
  354. {
  355. if (!strncmp(modestr, "picpar", 6))
  356. bc->options = 0;
  357. else if (!strncmp(modestr, "par96", 5))
  358. bc->options = BAYCOM_OPTIONS_SOFTDCD;
  359. else
  360. bc->options = !!strchr(modestr, '*');
  361. return 0;
  362. }
  363. /* --------------------------------------------------------------------- */
  364. static int baycom_ioctl(struct net_device *dev, struct ifreq *ifr,
  365. struct hdlcdrv_ioctl *hi, int cmd)
  366. {
  367. struct baycom_state *bc;
  368. struct baycom_ioctl bi;
  369. int cmd2;
  370. if (!dev || !dev->priv ||
  371.     ((struct baycom_state *)dev->priv)->hdrv.magic != HDLCDRV_MAGIC) {
  372. printk(KERN_ERR "bc_ioctl: invalid device structn");
  373. return -EINVAL;
  374. }
  375. bc = (struct baycom_state *)dev->priv;
  376. if (cmd != SIOCDEVPRIVATE)
  377. return -ENOIOCTLCMD;
  378. if (get_user(cmd2, (int *)ifr->ifr_data))
  379. return -EFAULT;
  380. switch (hi->cmd) {
  381. default:
  382. break;
  383. case HDLCDRVCTL_GETMODE:
  384. strcpy(hi->data.modename, bc->options ? "par96" : "picpar");
  385. if (copy_to_user(ifr->ifr_data, hi, sizeof(struct hdlcdrv_ioctl)))
  386. return -EFAULT;
  387. return 0;
  388. case HDLCDRVCTL_SETMODE:
  389. if (netif_running(dev) || !capable(CAP_NET_ADMIN))
  390. return -EACCES;
  391. hi->data.modename[sizeof(hi->data.modename)-1] = '';
  392. return baycom_setmode(bc, hi->data.modename);
  393. case HDLCDRVCTL_MODELIST:
  394. strcpy(hi->data.modename, "par96,picpar");
  395. if (copy_to_user(ifr->ifr_data, hi, sizeof(struct hdlcdrv_ioctl)))
  396. return -EFAULT;
  397. return 0;
  398. case HDLCDRVCTL_MODEMPARMASK:
  399. return HDLCDRV_PARMASK_IOBASE;
  400. }
  401. if (copy_from_user(&bi, ifr->ifr_data, sizeof(bi)))
  402. return -EFAULT;
  403. switch (bi.cmd) {
  404. default:
  405. return -ENOIOCTLCMD;
  406. #ifdef BAYCOM_DEBUG
  407. case BAYCOMCTL_GETDEBUG:
  408. bi.data.dbg.debug1 = bc->hdrv.ptt_keyed;
  409. bi.data.dbg.debug2 = bc->debug_vals.last_intcnt;
  410. bi.data.dbg.debug3 = bc->debug_vals.last_pllcorr;
  411. break;
  412. #endif /* BAYCOM_DEBUG */
  413. }
  414. if (copy_to_user(ifr->ifr_data, &bi, sizeof(bi)))
  415. return -EFAULT;
  416. return 0;
  417. }
  418. /* --------------------------------------------------------------------- */
  419. /*
  420.  * command line settable parameters
  421.  */
  422. static const char *mode[NR_PORTS] = { "picpar", };
  423. static int iobase[NR_PORTS] = { 0x378, };
  424. MODULE_PARM(mode, "1-" __MODULE_STRING(NR_PORTS) "s");
  425. MODULE_PARM_DESC(mode, "baycom operating mode; eg. par96 or picpar");
  426. MODULE_PARM(iobase, "1-" __MODULE_STRING(NR_PORTS) "i");
  427. MODULE_PARM_DESC(iobase, "baycom io base address");
  428. MODULE_AUTHOR("Thomas M. Sailer, sailer@ife.ee.ethz.ch, hb9jnx@hb9w.che.eu");
  429. MODULE_DESCRIPTION("Baycom par96 and picpar amateur radio modem driver");
  430. MODULE_LICENSE("GPL");
  431. /* --------------------------------------------------------------------- */
  432. static int __init init_baycompar(void)
  433. {
  434. int i, j, found = 0;
  435. char set_hw = 1;
  436. struct baycom_state *bc;
  437. printk(bc_drvinfo);
  438. /*
  439.  * register net devices
  440.  */
  441. for (i = 0; i < NR_PORTS; i++) {
  442. struct net_device *dev = baycom_device+i;
  443. char ifname[IFNAMSIZ];
  444. sprintf(ifname, "bcp%d", i);
  445. if (!mode[i])
  446. set_hw = 0;
  447. if (!set_hw)
  448. iobase[i] = 0;
  449. j = hdlcdrv_register_hdlcdrv(dev, &par96_ops, sizeof(struct baycom_state),
  450.      ifname, iobase[i], 0, 0);
  451. if (!j) {
  452. bc = (struct baycom_state *)dev->priv;
  453. if (set_hw && baycom_setmode(bc, mode[i]))
  454. set_hw = 0;
  455. found++;
  456. } else {
  457. printk(KERN_WARNING "%s: cannot register net devicen",
  458.        bc_drvname);
  459. }
  460. }
  461. if (!found)
  462. return -ENXIO;
  463. return 0;
  464. }
  465. static void __exit cleanup_baycompar(void)
  466. {
  467. int i;
  468. for(i = 0; i < NR_PORTS; i++) {
  469. struct net_device *dev = baycom_device+i;
  470. struct baycom_state *bc = (struct baycom_state *)dev->priv;
  471. if (bc) {
  472. if (bc->hdrv.magic != HDLCDRV_MAGIC)
  473. printk(KERN_ERR "baycom: invalid magic in "
  474.        "cleanup_modulen");
  475. else
  476. hdlcdrv_unregister_hdlcdrv(dev);
  477. }
  478. }
  479. }
  480. module_init(init_baycompar);
  481. module_exit(cleanup_baycompar);
  482. /* --------------------------------------------------------------------- */
  483. #ifndef MODULE
  484. /*
  485.  * format: baycom_par=io,mode
  486.  * mode: par96,picpar
  487.  */
  488. static int __init baycom_par_setup(char *str)
  489. {
  490.         static unsigned nr_dev;
  491. int ints[2];
  492.         if (nr_dev >= NR_PORTS)
  493.                 return 0;
  494.         str = get_options(str, 2, ints);
  495.         if (ints[0] < 1)
  496.                 return 0;
  497.         mode[nr_dev] = str;
  498.         iobase[nr_dev] = ints[1];
  499. nr_dev++;
  500. return 1;
  501. }
  502. __setup("baycom_par=", baycom_par_setup);
  503. #endif /* MODULE */
  504. /* --------------------------------------------------------------------- */