git.sur5r.net Git - ptouch-print/blob - src/libptouch.c

   1 /*
   2         libptouch - functions to help accessing a brother ptouch
   3
   4         Copyright (C) 2013 Dominic Radermacher <dominic.radermacher@gmail.com>
   5
   6         This program is free software; you can redistribute it and/or modify it
   7         under the terms of the GNU General Public License version 3 as
   8         published by the Free Software Foundation
   9
  10         This program is distributed in the hope that it will be useful, but
  11         WITHOUT ANY WARRANTY; without even the implied warranty of
  12         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  13         See the GNU General Public License for more details.
  14
  15         You should have received a copy of the GNU General Public License
  16         along with this program; if not, write to the Free Software Foundation,
  17         Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  18 */
  19
  20 #define _POSIX_C_SOURCE 199309L /* needed for nanosleep() when using -std=c11 */
  21
  22 #include <stdio.h>
  23 #include <stdlib.h>     /* malloc() */
  24 #include <string.h>     /* memcmp()  */
  25 #include <sys/types.h>  /* open() */
  26 #include <sys/stat.h>   /* open() */
  27 #include <fcntl.h>      /* open() */
  28 #include <time.h>       /* nanosleep(), struct timespec */
  29 #include "config.h"
  30 #include "gettext.h"    /* gettext(), ngettext() */
  31 #include "ptouch.h"
  32
  33 #define _(s) gettext(s)
  34
  35 struct _pt_tape_info tape_info[6]= {
  36         {6, 32},        /* 6mm tape is 32px wide? works for me ;-) */
  37         {9, 52},        /* 9mm tape is 52px wide? works for me ;-) */
  38         {12,76},        /* and 76px work for me on a 12mm tape - maybe its only 64px */
  39         {18,120},
  40         {24,128},
  41         {0,0}           /* terminating entry */
  42 };
  43
  44 struct _pt_dev_info ptdevs[] = {
  45         {0x04f9, 0x202d, "PT-2430PC", 128, 0},  /* 180dpi, maximum 128px */
  46         {0x04f9, 0x202c, "PT-1230PC", 76, 0},   /* 180dpi, supports tapes up to 12mm - I don't know how much pixels it can print! */
  47         {0,0,"",0,0}
  48 };
  49
  50 void ptouch_rawstatus(uint8_t raw[32]);
  51
  52 int ptouch_open(ptouch_dev *ptdev)
  53 {
  54         libusb_device **devs;
  55         libusb_device *dev;
  56         libusb_device_handle *handle = NULL;
  57         struct libusb_device_descriptor desc;
  58         ssize_t cnt;
  59         int r,i=0;
  60
  61         if ((*ptdev=malloc(sizeof(struct _ptouch_dev))) == NULL) {
  62                 fprintf(stderr, _("out of memory\n"));
  63                 return -1;
  64         }
  65         if ((libusb_init(NULL)) < 0) {
  66                 fprintf(stderr, _("libusb_init() failed\n"));
  67                 return -1;
  68         }
  69 //      libusb_set_debug(NULL, 3);
  70         if ((cnt=libusb_get_device_list(NULL, &devs)) < 0) {
  71                 return -1;
  72         }
  73         while ((dev=devs[i++]) != NULL) {
  74                 if ((r=libusb_get_device_descriptor(dev, &desc)) < 0) {
  75                         fprintf(stderr, _("failed to get device descriptor"));
  76                         libusb_free_device_list(devs, 1);
  77                         return -1;
  78                 }
  79                 for (int k=0; ptdevs[k].vid > 0; k++) {
  80                         if ((desc.idVendor == ptdevs[k].vid) && (desc.idProduct == ptdevs[k].pid) && (ptdevs[k].flags >= 0)) {
  81                                 fprintf(stderr, _("%s found on USB bus %d, device %d\n"),
  82                                         ptdevs[k].name,
  83                                         libusb_get_bus_number(dev),
  84                                         libusb_get_device_address(dev));
  85                                 if ((r=libusb_open(dev, &handle)) != 0) {
  86                                         fprintf(stderr, _("libusb_open error :%s\n"), libusb_error_name(r));
  87                                         return -1;
  88                                 }
  89                                 libusb_free_device_list(devs, 1);
  90                                 if ((r=libusb_kernel_driver_active(handle, 0)) == 1) {
  91                                         if ((r=libusb_detach_kernel_driver(handle, 0)) != 0) {
  92                                                 fprintf(stderr, _("error while detaching kernel driver: %s\n"), libusb_error_name(r));
  93                                         }
  94                                 }
  95                                 if ((r=libusb_claim_interface(handle, 0)) != 0) {
  96                                         fprintf(stderr, _("interface claim error: %s\n"), libusb_error_name(r));
  97                                         return -1;
  98                                 }
  99                                 (*ptdev)->h=handle;
 100                                 return 0;
 101                         }
 102                 }
 103         }
 104         fprintf(stderr, _("No P-Touch printer found on USB (remember to put switch to position E)\n"));
 105         libusb_free_device_list(devs, 1);
 106         return -1;
 107 }
 108
 109 int ptouch_close(ptouch_dev ptdev)
 110 {
 111         libusb_release_interface(ptdev->h, 0);
 112         libusb_close(ptdev->h);
 113         return 0;
 114 }
 115
 116 int ptouch_send(ptouch_dev ptdev, uint8_t *data, int len)
 117 {
 118         int r,tx;
 119
 120         if (ptdev == NULL) {
 121                 return -1;
 122         }
 123         if ((r=libusb_bulk_transfer(ptdev->h, 0x02, data, len, &tx, 0)) != 0) {
 124                 fprintf(stderr, _("write error: %s\n"), libusb_error_name(r));
 125                 return -1;
 126         }
 127         if (tx != len) {
 128                 fprintf(stderr, _("write error: could send only %i of %i bytes\n"), tx, len);
 129                 return -1;
 130         }
 131         return 0;
 132 }
 133
 134 int ptouch_init(ptouch_dev ptdev)
 135 {
 136         char cmd[]="\x1b\x40";          /* 1B 40 = ESC @ = INIT */
 137         return ptouch_send(ptdev, (uint8_t *)cmd, strlen(cmd));
 138 }
 139
 140 int ptouch_rasterstart(ptouch_dev ptdev)
 141 {
 142         char cmd[]="\x1b\x69\x52\x01";  /* 1B 69 52 01 = RASTER DATA */
 143         return ptouch_send(ptdev, (uint8_t *)cmd, strlen(cmd));
 144 }
 145
 146 /* print an empty line */
 147 int ptouch_lf(ptouch_dev ptdev)
 148 {
 149         char cmd[]="\x5a";
 150         return ptouch_send(ptdev, (uint8_t *)cmd, strlen(cmd));
 151 }
 152
 153 /* print and advance tape, but do not cut */
 154 int ptouch_ff(ptouch_dev ptdev)
 155 {
 156         char cmd[]="\x0c";
 157         return ptouch_send(ptdev, (uint8_t *)cmd, strlen(cmd));
 158 }
 159
 160 /* print and cut tape */
 161 int ptouch_eject(ptouch_dev ptdev)
 162 {
 163         char cmd[]="\x1a";
 164         return ptouch_send(ptdev, (uint8_t *)cmd, strlen(cmd));
 165 }
 166
 167 /* print a "cut here" mark (it's just a dashed line) */
 168 #define CUTMARK_SPACING 5
 169 int ptouch_cutmark(ptouch_dev ptdev)
 170 {
 171         uint8_t buf[32];
 172         int i,len=16;
 173
 174         for (i=0; i<CUTMARK_SPACING; i++) {
 175                 ptouch_lf(ptdev);
 176         }
 177         ptouch_rasterstart(ptdev);
 178         buf[0]=0x47;
 179         buf[1]=len;
 180         buf[2]=0;
 181         memset(buf+3, 0, len);
 182         int offset=(64-ptouch_getmaxwidth(ptdev)/2);
 183         for (i=0; i<ptouch_getmaxwidth(ptdev); i++) {
 184                 if ((i%8) <= 3) {       /* pixels 0-3 get set, 4-7 are unset */
 185                         buf[3+15-((offset+i)/8)] |= 1<<((offset+i)%8);
 186                 }
 187         }
 188         ptouch_send(ptdev, buf, len+3);
 189         for (i=0; i<CUTMARK_SPACING; i++) {
 190                 ptouch_lf(ptdev);
 191         }
 192         return 0;
 193 }
 194
 195 void ptouch_rawstatus(uint8_t raw[32])
 196 {
 197         fprintf(stderr, _("debug: dumping raw status bytes\n"));
 198         for (int i=0; i<32; i++) {
 199                 fprintf(stderr, "%02x ", raw[i]);
 200                 if (((i+1) % 16) == 0) {
 201                         fprintf(stderr, "\n");
 202                 }
 203         }
 204         fprintf(stderr, "\n");
 205         return;
 206 }
 207
 208 int ptouch_getstatus(ptouch_dev ptdev)
 209 {
 210         char cmd[]="\x1b\x69\x53";
 211         uint8_t buf[32];
 212         int i, r, tx=0, tries=0;
 213         struct timespec w;
 214
 215         ptouch_send(ptdev, (uint8_t *)cmd, strlen(cmd));
 216         while (tx == 0) {
 217                 w.tv_sec=0;
 218                 w.tv_nsec=100000000;    /* 0.1 sec */
 219                 r=nanosleep(&w, NULL);
 220                 if ((r=libusb_bulk_transfer(ptdev->h, 0x81, buf, 32, &tx, 0)) != 0) {
 221                         fprintf(stderr, _("read error: %s\n"), libusb_error_name(r));
 222                         return -1;
 223                 }
 224                 tries++;
 225                 if (tries > 10) {
 226                         fprintf(stderr, _("timeout while waiting for status response\n"));
 227                         return -1;
 228                 }
 229         }
 230         if (tx == 32) {
 231                 if (buf[0]==0x80 && buf[1]==0x20) {
 232                         memcpy(ptdev->raw, buf, 32);
 233                         if (buf[8] != 0) {
 234                                 fprintf(stderr, _("Error 1 = %02x\n"), buf[8]);
 235                         }
 236                         if (buf[9] != 0) {
 237                                 fprintf(stderr, _("Error 2 = %02x\n"), buf[9]);
 238                         }
 239                         ptdev->tape_width_mm=buf[10];
 240                         ptdev->tape_width_px=0;
 241                         for (i=0; tape_info[i].mm > 0; i++) {
 242                                 if (tape_info[i].mm == buf[10]) {
 243                                         ptdev->tape_width_px=tape_info[i].px;
 244                                 }
 245                         }
 246                         if (ptdev->tape_width_px == 0) {
 247                                 fprintf(stderr, _("unknown tape width of %imm, please report this.\n"), buf[10]);
 248                         }
 249                         ptdev->media_type=buf[11];
 250                         ptdev->status=buf[18];
 251                         return 0;
 252                 }
 253         }
 254         if (tx == 16) {
 255                 fprintf(stderr, _("got only 16 bytes... wondering what they are:\n"));
 256                 ptouch_rawstatus(buf);
 257         }
 258         if (tx != 32) {
 259                 fprintf(stderr, _("read error: got %i instead of 32 bytes\n"), tx);
 260                 return -1;
 261         }
 262         fprintf(stderr, _("strange status:\n"));
 263         ptouch_rawstatus(buf);
 264         fprintf(stderr, _("trying to flush junk\n"));
 265         if ((r=libusb_bulk_transfer(ptdev->h, 0x81, buf, 32, &tx, 0)) != 0) {
 266                 fprintf(stderr, _("read error: %s\n"), libusb_error_name(r));
 267                 return -1;
 268         }
 269         fprintf(stderr, _("got another %i bytes. now try again\n"), tx);
 270         return -1;
 271 }
 272
 273 int ptouch_getmaxwidth(ptouch_dev ptdev)
 274 {
 275         return ptdev->tape_width_px;
 276 }
 277
 278 int ptouch_sendraster(ptouch_dev ptdev, uint8_t *data, int len)
 279 {
 280         uint8_t buf[32];
 281
 282         if (len > 16) {         /* PT-2430PC can not print more than 128 px */
 283                 return -1;      /* as we support more devices, we need to check */
 284         }                       /* how much pixels each device support */
 285         buf[0]=0x47;
 286         buf[1]=len;
 287         buf[2]=0;
 288         memcpy(buf+3, data, len);
 289         return ptouch_send(ptdev, buf, len+3);
 290 }