slp/selphy_print
1
0
Fork 0
Code Issues 48 Pull requests Activity

s2145: Add a spooler for the Shinko/Sinfonia CHC-S2145.

Browse source 
...It doesn't work yet, something is wrong with the raw data xfer.
This commit is contained in:
Solomon Peachy 2013-07-06 10:14:06 -04:00
parent e1ea0359fd
commit d8751e8f81
4 changed files with 733 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
.gitignore vendored
View file

@ -2,3 +2,4 @@
selphy_print
kodak1400_print
kodak6800_print
s2145_print

8
Makefile
View file

@ -4,7 +4,7 @@ LDFLAGS = -lusb-1.0
CUPS_BACKEND_DIR = /usr/lib/cups/backend
DEPS = backend_common.c
all: selphy_print kodak1400_print kodak6800_print
all: selphy_print kodak1400_print kodak6800_print s2145_print
selphy_print: selphy_print.c $(DEPS)
gcc -o $@ $< $(LDFLAGS) $(CFLAGS)
@ -15,10 +15,14 @@ kodak6800_print: kodak6800_print.c $(DEPS)
kodak1400_print: kodak1400_print.c $(DEPS)
gcc -o $@ $< $(LDFLAGS) $(CFLAGS)
s2145_print: s2145_print.c $(DEPS)
gcc -o $@ $< $(LDFLAGS) $(CFLAGS)
install:
install -o root -m 700 selphy_print $(CUPS_BACKEND_DIR)/selphy
install -o root -m 700 kodak1400_print $(CUPS_BACKEND_DIR)/kodak1400
install -o root -m 700 kodak6800_print $(CUPS_BACKEND_DIR)/kodak6800
install -o root -m 700 s2145_print $(CUPS_BACKEND_DIR)/s2145
clean:
rm -f selphy_print kodak6800_print kodak1400_print
rm -f selphy_print kodak6800_print kodak1400_print s2145

723
s2145_print.c Normal file
View file

@ -0,0 +1,723 @@
/*
* Shinko/Sinfonia CHC-S2145 CUPS backend -- libusb-1.0 version
*
* (c) 2013 Solomon Peachy <pizza@shaftnet.org>
*
* The latest version of this program can be found at:
*
* http://git.shaftnet.org/git/gitweb.cgi?p=selphy_print.git
*
* This program is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by the Free
* Software Foundation; either version 3 of the License, or (at your option)
* any later version.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*
* [http://www.gnu.org/licenses/gpl-3.0.html]
*
*/
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <signal.h>
#define VERSION "0.01"
#define URI_PREFIX "s2145://"
#include "backend_common.c"
/* USB Identifiers */
#define USB_VID_SHINKO 0x10CE
#define USB_PID_SHINKO_S2145 0x000E
enum {
S_IDLE = 0,
S_PRINTER_READY_CMD,
S_PRINTER_SENT_PRINT_CMD,
S_PRINTER_SENT_DATA,
S_FINISHED,
};
/* Structure of printjob header. All fields are LITTLE ENDIAN */
struct s2145_printjob_hdr {
uint32_t len1; /* Fixed at 0x10 */
uint32_t model; /* Fixed at '2145' (decimal) */
uint32_t unk2;
uint32_t unk3;
uint32_t len2; /* Fixed at 0x64 */
uint32_t unk5;
uint32_t media;
uint32_t unk6;
uint32_t method;
uint32_t mode;
uint32_t unk7;
uint32_t unk8;
uint32_t unk9;
uint32_t columns;
uint32_t rows;
uint32_t copies;
uint32_t unk10;
uint32_t unk11;
uint32_t unk12;
uint32_t unk13;
uint32_t unk14;
uint32_t unk15;
uint32_t dpi; /* Fixed at '300' (decimal) */
uint32_t unk16;
uint32_t unk17;
uint32_t unk18;
uint32_t unk19;
uint32_t unk20;
uint32_t unk21;
} __attribute__((packed));
/* Structs for printer */
struct s2145_cmd_hdr {
uint16_t cmd;
uint16_t len; /* Not including this header */
} __attribute__((packed));
#define S2145_CMD_STATUS 0x0001
#define S2145_CMD_MEDIAINFO 0x0002
#define S2145_CMD_MODELNAME 0x0003
#define S2145_CMD_ERRORLOG 0x0004
#define S2145_CMD_PRINTJOB 0x4001
#define S2145_CMD_CANCELJOB 0x4002
#define S2145_CMD_FLASHLED 0x4003
#define S2145_CMD_RESET 0x4004
#define S2145_CMD_READTONE 0x4005
#define S2145_CMD_BUTTON 0x4006
#define S2145_CMD_GETUNIQUE 0x8003
#define S2145_CMD_FWINFO 0xC003
#define S2145_CMD_UPDATE 0xC004
#define S2145_CMD_SETUNIQUE 0xC007
struct s2145_print_cmd {
struct s2145_cmd_hdr hdr;
uint8_t id;
uint16_t count;
uint16_t columns;
uint16_t rows;
uint8_t media;
uint8_t mode;
uint8_t method;
} __attribute__((packed));
struct s2145_cancel_cmd {
struct s2145_cmd_hdr hdr;
uint8_t id;
} __attribute__((packed));
struct s2145_reset_cmd {
struct s2145_cmd_hdr hdr;
uint8_t target;
} __attribute__((packed));
struct s2145_readtone_cmd {
struct s2145_cmd_hdr hdr;
uint8_t curveid;
} __attribute__((packed));
struct s2145_button_cmd {
struct s2145_cmd_hdr hdr;
uint8_t enabled;
} __attribute__((packed));
struct s2145_fwinfo_cmd {
struct s2145_cmd_hdr hdr;
uint8_t target;
} __attribute__((packed));
struct s2145_update_cmd {
struct s2145_cmd_hdr hdr;
uint8_t target;
uint32_t reserved;
uint32_t size;
} __attribute__((packed));
struct s2145_setunique_cmd {
struct s2145_cmd_hdr hdr;
uint8_t len;
uint8_t data[23]; /* Not necessarily all used. */
} __attribute__((packed));
struct s2145_status_hdr {
uint8_t result;
uint8_t error;
uint8_t printer_major;
uint8_t printer_minor;
uint8_t reserved[3];
uint8_t status;
uint16_t payload_len;
} __attribute__((packed));
#define RESULT_SUCCESS 0x01
#define RESULT_FAIL 0x02
#define ERROR_NONE 0x00
#define ERROR_INVALID_PARAM 0x01
#define ERROR_MAIN_APP_INACTIVE 0x02
#define ERROR_COMMS_TIMEOUT 0x03
#define ERROR_MAINT_NEEDED 0x04
#define ERROR_BAD_COMMAND 0x05
#define ERROR_PRINTER 0x11
#define ERROR_BUFFER_FULL 0x21
#define STATUS_READY 0x00
#define STATUS_INIT_CPU 0x31
#define STATUS_INIT_RIBBON 0x32
#define STATUS_INIT_PAPER 0x33
#define STATUS_THERMAL_PROTECT 0x34
#define STATUS_USING_PANEL 0x35
#define STATUS_SELF_DIAG 0x36
#define STATUS_DOWNLOADING 0x37
#define STATUS_FEEDING_PAPER 0x61
#define STATUS_PRE_HEAT 0x62
#define STATUS_PRINT_Y 0x63
#define STATUS_BACK_FEED_Y 0x64
#define STATUS_PRINT_M 0x65
#define STATUS_BACK_FEED_M 0x66
#define STATUS_PRINT_C 0x67
#define STATUS_BACK_FEED_C 0x68
#define STATUS_PRINT_QP 0x69
#define STATUS_PAPER_CUT 0x6A
#define STATUS_PAPER_EJECT 0x6B
#define STATUS_BACK_FEED_E 0x6C
#define STATUS_FINISHED 0x6D
struct s2145_status_resp {
struct s2145_status_hdr hdr;
uint32_t count_lifetime;
uint32_t count_maint;
uint32_t count_paper;
uint32_t count_cutter;
uint32_t count_head;
uint32_t count_ribbon_left;
uint8_t bank1_printid;
uint8_t bank2_printid;
uint16_t bank1_remaining;
uint16_t bank1_finished;
uint16_t bank1_specified;
uint8_t bank1_status;
uint16_t bank2_remaining;
uint16_t bank2_finished;
uint16_t bank2_specified;
uint8_t bank2_status;
uint8_t tonecurve_status;
} __attribute__((packed));
#define BANK_STATUS_FREE 0x00
#define BANK_STATUS_XFER 0x01
#define BANK_STATUS_FULL 0x02
struct s2145_readtone_resp {
struct s2145_status_hdr hdr;
uint8_t blocks_remain;
uint8_t block_len;
uint8_t payload[256]; /* Not all necessarily used */
} __attribute__((packed));
struct s2145_mediainfo_item {
uint8_t code;
uint16_t columns;
uint16_t rows;
uint8_t media_type;
uint8_t print_type;
uint8_t reserved[3];
} __attribute__((packed));
struct s2145_mediainfo_resp {
struct s2145_status_hdr hdr;
uint8_t count;
struct s2145_mediainfo_item items[10]; /* Not all necessarily used */
} __attribute__((packed));
struct s2145_modelname_resp {
struct s2145_status_hdr hdr;
uint8_t vendor[4];
uint8_t product[4];
uint8_t modelname[40];
} __attribute__((packed));
struct s2145_error_item {
uint8_t major;
uint8_t minor;
uint32_t print_counter;
} __attribute__((packed));
struct s2145_errorlist_resp {
struct s2145_status_hdr hdr;
uint8_t count;
struct s2145_error_item items[10]; /* Not all necessarily used */
} __attribute__((packed));
struct s2145_fwinfo_resp {
struct s2145_status_hdr hdr;
uint8_t name[8];
uint8_t type[16];
uint8_t date[10];
uint8_t major;
uint8_t mainor;
uint16_t checksum;
} __attribute__((packed));
#define READBACK_LEN sizeof(struct s2145_status_resp)
#define CMDBUF_LEN sizeof(struct s2145_print_cmd)
static int find_and_enumerate(struct libusb_context *ctx,
struct libusb_device ***list,
char *match_serno,
int scan_only)
{
int num;
int i;
int found = -1;
/* Enumerate and find suitable device */
num = libusb_get_device_list(ctx, list);
for (i = 0 ; i < num ; i++) {
struct libusb_device_descriptor desc;
libusb_get_device_descriptor((*list)[i], &desc);
if (desc.idVendor != USB_VID_SHINKO)
continue;
switch(desc.idProduct) {
case USB_PID_SHINKO_S2145:
found = i;
break;
default:
continue;
}
found = print_scan_output((*list)[i], &desc,
URI_PREFIX, "Shinko",
found, (found == i), 1,
scan_only, match_serno);
}
return found;
}
int main (int argc, char **argv)
{
struct libusb_context *ctx;
struct libusb_device **list;
struct libusb_device_handle *dev;
struct libusb_config_descriptor *config;
uint8_t endp_up = 0;
uint8_t endp_down = 0;
int data_fd = fileno(stdin);
int i, num;
int claimed;
int ret = 0;
int iface = 0;
int found = -1;
int copies = 1;
int jobid = 0;
char *uri = getenv("DEVICE_URI");;
char *use_serno = NULL;
struct s2145_printjob_hdr hdr;
struct s2145_cmd_hdr *cmd;
struct s2145_print_cmd *print;
struct s2145_status_resp *sts;
uint8_t *planedata, *cmdbuf;
uint32_t datasize;
uint8_t rdbuf[READBACK_LEN];
uint8_t rdbuf2[READBACK_LEN];
int last_state = -1, state = S_IDLE;
DEBUG("Shinko/Sinfonia CHC-S2145 CUPS backend version " VERSION "/" BACKEND_VERSION " \n");
/* Cmdline help */
if (argc < 2) {
DEBUG("Usage:\n\t%s [ infile | - ]\n\t%s job user title num-copies options [ filename ] \n\n",
argv[0], argv[0]);
libusb_init(&ctx);
find_and_enumerate(ctx, &list, NULL, 1);
libusb_free_device_list(list, 1);
libusb_exit(ctx);
exit(1);
}
/* Are we running as a CUPS backend? */
if (uri) {
if (argv[1])
jobid = atoi(argv[1]);
if (argv[4])
copies = atoi(argv[4]);
if (argv[6]) { /* IOW, is it specified? */
data_fd = open(argv[6], O_RDONLY);
if (data_fd < 0) {
perror("ERROR:Can't open input file");
exit(1);
}
}
/* Ensure we're using BLOCKING I/O */
i = fcntl(data_fd, F_GETFL, 0);
if (i < 0) {
perror("ERROR:Can't open input");
exit(1);
}
i &= ~O_NONBLOCK;
i = fcntl(data_fd, F_SETFL, 0);
if (i < 0) {
perror("ERROR:Can't open input");
exit(1);
}
/* Start parsing URI 'selphy://PID/SERIAL' */
if (strncmp(URI_PREFIX, uri, strlen(URI_PREFIX))) {
ERROR("Invalid URI prefix (%s)\n", uri);
exit(1);
}
use_serno = strchr(uri, '=');
if (!use_serno || !*(use_serno+1)) {
ERROR("Invalid URI (%s)\n", uri);
exit(1);
}
use_serno++;
} else {
srand(getpid());
jobid = rand();
/* Open Input File */
if (strcmp("-", argv[1])) {
data_fd = open(argv[1], O_RDONLY);
if (data_fd < 0) {
perror("ERROR:Can't open input file");
exit(1);
}
}
}
/* Ignore SIGPIPE */
signal(SIGPIPE, SIG_IGN);
signal(SIGTERM, sigterm_handler);
/* Ensure jobid is sane */
jobid = (jobid & 0x7f) + 1;
/* Read in then validate header */
read(data_fd, &hdr, sizeof(hdr));
if (le32_to_cpu(hdr.len1) != 0x10 ||
le32_to_cpu(hdr.model) != 2145 ||
le32_to_cpu(hdr.len2) != 0x64 ||
le32_to_cpu(hdr.dpi) != 300) {
ERROR("Unrecognized header data format!\n");
exit(1);
}
/* Read in image data */
cmdbuf = malloc(CMDBUF_LEN);
cmd = (struct s2145_cmd_hdr *) cmdbuf;
print = (struct s2145_print_cmd *) cmdbuf;
sts = (struct s2145_status_resp *) rdbuf;
datasize = le32_to_cpu(hdr.rows) * le32_to_cpu(hdr.columns) * 3;
planedata = malloc(datasize);
if (!cmdbuf || !planedata) {
ERROR("Memory allocation failure!\n");
exit(1);
}
{
int remain;
uint8_t *ptr = planedata;
remain = datasize;
do {
ret = read(data_fd, ptr, remain);
if (ret < 0) {
ERROR("Read failed (%d/%d/%d)\n",
ret, remain, datasize);
perror("ERROR: Read failed");
exit(1);
}
ptr += ret;
remain -= ret;
} while (remain);
}
/* Make sure footer is sane too */
ret = read(data_fd, cmdbuf, 4);
if (ret < 0 || ret != 4) {
ERROR("Read failed (%d/%d/%d)\n",
ret, 4, 4);
perror("ERROR: Read failed");
exit(1);
}
if (cmdbuf[0] != 0x04 ||
cmdbuf[1] != 0x03 ||
cmdbuf[2] != 0x02 ||
cmdbuf[3] != 0x01) {
ERROR("Unrecognized footer data format!\n");
exit(1);
}
close(data_fd); /* We're done reading! */
/* Libusb setup */
libusb_init(&ctx);
found = find_and_enumerate(ctx, &list, use_serno, 0);
if (found == -1) {
ERROR("Printer open failure (No suitable printers found!)\n");
ret = 3;
goto done;
}
ret = libusb_open(list[found], &dev);
if (ret) {
ERROR("Printer open failure (Need to be root?) (%d)\n", ret);
ret = 4;
goto done;
}
claimed = libusb_kernel_driver_active(dev, iface);
if (claimed) {
ret = libusb_detach_kernel_driver(dev, iface);
if (ret) {
ERROR("Printer open failure (Could not detach printer from kernel)\n");
ret = 4;
goto done_close;
}
}
ret = libusb_claim_interface(dev, iface);
if (ret) {
ERROR("Printer open failure (Could not claim printer interface)\n");
ret = 4;
goto done_close;
}
ret = libusb_get_active_config_descriptor(list[found], &config);
if (ret) {
ERROR("Printer open failure (Could not fetch config descriptor)\n");
ret = 4;
goto done_close;
}
for (i = 0 ; i < config->interface[0].altsetting[0].bNumEndpoints ; i++) {
if ((config->interface[0].altsetting[0].endpoint[i].bmAttributes & 3) == LIBUSB_TRANSFER_TYPE_BULK) {
if (config->interface[0].altsetting[0].endpoint[i].bEndpointAddress & LIBUSB_ENDPOINT_IN)
endp_up = config->interface[0].altsetting[0].endpoint[i].bEndpointAddress;
else
endp_down = config->interface[0].altsetting[0].endpoint[i].bEndpointAddress;
}
}
/* Time for the main processing loop */
top:
/* Send State Query */
memset(cmdbuf, 0, CMDBUF_LEN);
cmd->cmd = cpu_to_le16(S2145_CMD_STATUS);
cmd->len = cpu_to_le16(0);
if ((ret = send_data(dev, endp_down,
(uint8_t *) cmd, sizeof(*cmd))))
goto done_claimed;
/* Read in the printer status */
memset(rdbuf, 0, READBACK_LEN);
ret = libusb_bulk_transfer(dev, endp_up,
rdbuf,
READBACK_LEN,
&num,
5000);
if (ret < 0 || (num < sizeof(struct s2145_status_hdr))) {
ERROR("Failure to receive data from printer (libusb error %d: (%d/%d from 0x%02x))\n", ret, num, (int)READBACK_LEN, endp_up);
ret = 4;
goto done_claimed;
}
if (memcmp(rdbuf, rdbuf2, READBACK_LEN)) {
DEBUG("readback: ");
for (i = 0 ; i < num ; i++) {
DEBUG2("%02x ", rdbuf[i]);
}
DEBUG2("\n");
} else {
sleep(1);
}
if (state != last_state) {
DEBUG("last_state %d new %d\n", last_state, state);
last_state = state;
}
fflush(stderr);
switch (state) {
case S_IDLE:
INFO("Waiting for printer idle\n");
/* Basic error handling */
if (sts->hdr.result != RESULT_SUCCESS)
goto printer_error;
if (sts->hdr.status != ERROR_NONE)
goto printer_error;
/* If either bank is free, continue */
if (sts->bank1_status == BANK_STATUS_FREE ||
sts->bank2_status == BANK_STATUS_FREE)
state = S_PRINTER_READY_CMD;
break;
case S_PRINTER_READY_CMD:
INFO("Initiating print job (internal id %d)\n", jobid);
memset(cmdbuf, 0, CMDBUF_LEN);
print->hdr.cmd = cpu_to_le16(S2145_CMD_PRINTJOB);
print->hdr.len = cpu_to_le16(sizeof (*print) - sizeof(*cmd));
print->id = jobid;
print->count = cpu_to_le16(copies);
print->columns = cpu_to_le16(le32_to_cpu(hdr.columns));
print->rows = cpu_to_le16(le32_to_cpu(hdr.rows));
print->media = le32_to_cpu(hdr.media);
print->mode = le32_to_cpu(hdr.mode);
print->method = le32_to_cpu(hdr.method);
DEBUG("printcmd: ");
for (i = 0 ; i < sizeof(*print) ; i++) {
DEBUG2("%02x ", cmdbuf[i]);
}
DEBUG2("\n");
if ((ret = send_data(dev, endp_down,
(uint8_t *) print, sizeof(*print))))
goto done_claimed;
state = S_PRINTER_SENT_PRINT_CMD;
break;
case S_PRINTER_SENT_PRINT_CMD:
if (sts->hdr.result != RESULT_SUCCESS) {
if (sts->hdr.status == ERROR_BUFFER_FULL) {
INFO("Buffers full, retrying\n");
state = S_PRINTER_READY_CMD;
break;
} else if (sts->hdr.status != ERROR_NONE)
goto printer_error;
}
INFO("Sending data to printer\n");
if ((ret = send_data(dev, endp_down, planedata, datasize)))
goto done_claimed;
state = S_PRINTER_SENT_DATA;
break;
case S_PRINTER_SENT_DATA:
INFO("Waiting for printer to acknowledge completion\n");
state = S_FINISHED;
break;
default:
break;
};
if (state != S_FINISHED)
goto top;
/* This printer handles copies internally */
copies = 1;
/* Clean up */
if (terminate)
copies = 1;
INFO("Print complete (%d remaining)\n", copies - 1);
if (copies && --copies) {
state = S_IDLE;
goto top;
}
/* Done printing */
INFO("All printing done\n");
ret = 0;
goto done_claimed;
printer_error:
ERROR("Printer reported error: %#x (%#x) -> %#x.%#x\n", sts->hdr.error, sts->hdr.status, sts->hdr.printer_major, sts->hdr.printer_minor);
// XXX write this.
done_claimed:
libusb_release_interface(dev, iface);
done_close:
if (claimed)
libusb_attach_kernel_driver(dev, iface);
libusb_close(dev);
done:
if (planedata)
free(planedata);
if (cmdbuf)
free(cmdbuf);
libusb_free_device_list(list, 1);
libusb_exit(ctx);
return ret;
}
/* CHC-S2145 data format
Spool file consists of an 116-byte header, followed by RGB-packed data,
followed by a 4-byte footer. Header appears to consist of a series of
4-byte Little Endian words.
10 00 00 00 MM MM 00 00 00 00 00 00 01 00 00 00 MM == Model (ie 2145d)
64 00 00 00 00 00 00 00 TT 00 00 00 00 00 00 00 TT == Media Type
MM 00 00 00 PP 00 00 00 00 00 00 00 00 00 00 00 PP = Print Mode, MM = Print Method
00 00 00 00 WW WW 00 00 HH HH 00 00 XX 00 00 00 XX == Copies
00 00 00 00 00 00 00 00 00 00 00 00 ce ff ff ff
00 00 00 00 ce ff ff ff QQ QQ 00 00 ce ff ff ff QQ == DPI, ie 300.
00 00 00 00 ce ff ff ff 00 00 00 00 00 00 00 00
00 00 00 00
[[Packed RGB payload of WW*HH*3 bytes]]
04 03 02 01 [[ footer ]]
************************************************************************
The data format actually sent to the CHC-S2145 is different, but not
radically so:
*/

BIN
testjobs/s2145_4x6.raw (Stored with Git LFS) Normal file
View file

Binary file not shown.