selphy_print/backend_sonyupdneo.c

1024 lines
30 KiB
C
Raw Normal View History

/*
* Sony UP-D series (new) Photo Printer CUPS backend -- libusb-1.0 version
*
* (c) 2019-2020 Solomon Peachy <pizza@shaftnet.org>
*
* The latest version of this program can be found at:
*
* https://git.shaftnet.org/cgit/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, see <https://www.gnu.org/licenses/>.
*
* SPDX-License-Identifier: GPL-3.0+
*
*/
#define BACKEND sonyupdneo_backend
#include "backend_common.h"
/* Private data structures */
struct updneo_printjob {
size_t jobsize;
int copies;
uint8_t *databuf;
int datalen;
uint8_t *hdrbuf;
int hdrlen;
uint8_t *ftrbuf;
int ftrlen;
uint16_t rows;
uint16_t cols;
};
struct updneo_sts {
uint16_t scdiv;
uint32_t scsyv;
char scsno[17]; /* 16 char string, leading 0s */
char scsys[23]; /* 22 char string, mostly unknown */
uint16_t scmds[5];
uint16_t scprs;
uint16_t scses;
uint16_t scwts;
uint16_t scjbs;
uint8_t scsye;
uint16_t scmde;
uint8_t scmce;
char scjbi[17]; /* 16 char string, unknown */
char scsyi[31]; /* 30 char string, max resolution? */
uint32_t scsvi[2]; /* 2* 6char numbers */
uint32_t scmni[2]; /* 2* 6char numbers */
char sccai[15]; /* 14 char string, unknown */
uint16_t scgai;
uint8_t scgsi;
uint32_t scmdi;
uint32_t scqti;
uint32_t spuqi;
};
struct updneo_ctx {
struct dyesub_connection *conn;
int native_bpp;
struct updneo_sts sts;
struct marker marker;
};
/* Forward declaration */
static int updneo_get_status(struct updneo_ctx *ctx);
/* Now for the code */
static const char* updneo_decode_errors(uint16_t mde, uint8_t mce, uint8_t sye)
{
if (!mde && !mce && sye)
return "None";
if (mde == 0x0800 || mce == 0x1)
return "Cover open";
if (mde == 0x0a00)
return "No paper loaded";
if (mde == 0x0002)
return "No ribbon loaded";
if (mde == 0x0300)
return "No media loaded";
if (mde == 0x2000)
return "Job does not match installed media";
return "Unknown";
}
static void* updneo_init(void)
{
struct updneo_ctx *ctx = malloc(sizeof(struct updneo_ctx));
if (!ctx) {
ERROR("Memory Allocation Failure!\n");
return NULL;
}
memset(ctx, 0, sizeof(struct updneo_ctx));
return ctx;
}
static const char *updneo_medias(uint32_t mdi)
{
mdi >>= 16;
mdi &= 0xff;
switch(mdi) {
case 0x11: return "UPC-R81MD (Letter)";
// UPC-R80MD (A4)
case 0x20: return "UPP-110 Roll";
default: return "Unknown";
}
}
static int updneo_attach(void *vctx, struct dyesub_connection *conn, uint8_t jobid)
{
struct updneo_ctx *ctx = vctx;
int ret;
UNUSED(jobid);
ctx->conn = conn;
if (test_mode < TEST_MODE_NOATTACH) {
if ((ret = updneo_get_status(ctx))) {
return ret;
}
/* Needed by the UP-D898! But should be safe for
all models */
libusb_reset_device(ctx->conn->dev);
} else {
if (ctx->conn->type == P_SONY_UPD898) {
strcpy(ctx->sts.scsyi, "100005001000050000000000014500");
} else if (ctx->conn->type == P_SONY_UPDR80) {
strcpy(ctx->sts.scsyi, "0A300E5609A00C7809A00C78012D00");
}
// XXX don't forget cr20l here.
}
if (test_mode >= TEST_MODE_NOATTACH && getenv("MEDIA_CODE"))
ctx->marker.numtype = atoi(getenv("MEDIA_CODE"));
else
ctx->marker.numtype = (ctx->sts.scmdi >> 16) & 0xff;
ctx->marker.name = updneo_medias(ctx->sts.scmdi);
if (ctx->conn->type == P_SONY_UPD898) {
ctx->marker.color = "#000000"; /* Ie black! */
ctx->native_bpp = 1;
ctx->marker.levelmax = CUPS_MARKER_UNAVAILABLE;
ctx->marker.levelnow = CUPS_MARKER_UNKNOWN;
} else {
ctx->marker.color = "#00FFFF#FF00FF#FFFF00";
ctx->native_bpp = 3;
ctx->marker.levelmax = 50;
ctx->marker.numtype = (ctx->sts.scmdi >> 16) & 0xff;
ctx->marker.levelnow = ctx->sts.scmds[4];
}
return CUPS_BACKEND_OK;
}
static void updneo_cleanup_job(const void *vjob)
{
const struct updneo_printjob *job = vjob;
if (job->databuf)
free(job->databuf);
if (job->hdrbuf)
free(job->hdrbuf);
if (job->ftrbuf)
free(job->ftrbuf);
free((void*)job);
}
#define MAX_PRINTJOB_LEN (3400*2392*3 + 2048)
static int updneo_read_parse(void *vctx, const void **vjob, int data_fd, int copies) {
struct updneo_ctx *ctx = vctx;
int run = 1;
uint8_t tmpbuf[257];
struct updneo_printjob *job = NULL;
if (!ctx)
return CUPS_BACKEND_FAILED;
/* Allocate job */
job = malloc(sizeof(*job));
if (!job) {
ERROR("Memory allocation failure!\n");
return CUPS_BACKEND_RETRY_CURRENT;
}
memset(job, 0, sizeof(*job));
/* Read in data chunks. */
while(run) {
uint8_t *ptr = NULL;
int i, len, *lenptr;
/* Read in data block header (256 bytes) */
i = read(data_fd, tmpbuf, 256);
if (i < 0) {
ERROR("Read failed (%d)\n", i);
updneo_cleanup_job(job);
return CUPS_BACKEND_CANCEL;
}
if (i == 0)
break;
/* Explicitly null terminate just in case */
tmpbuf[256] = 0;
/* Parse header. Format:
JOBSIZE=pdlname,blocklen,printsize,arg1,..,argN<NULL>
*/
if (strncmp("JOBSIZE=", (char*) tmpbuf, 8)) {
updneo_cleanup_job(job);
ERROR("Invalid spool format!\n");
return CUPS_BACKEND_CANCEL;
}
/* PDL type */
char *tok = strtok((char*)&tmpbuf[8], "\r\n,");
if (!tok) {
updneo_cleanup_job(job);
ERROR("Invalid spool format (PDL)!\n");
return CUPS_BACKEND_CANCEL;
}
/* Payload length */
char *tokl = strtok(NULL, "\r\n,");
if (!tokl) {
2019-05-12 08:17:56 -04:00
updneo_cleanup_job(job);
ERROR("Invalid spool format (block length missing)!\n");
return CUPS_BACKEND_CANCEL;
}
len = atoi(tokl);
if (len == 0 || len > MAX_PRINTJOB_LEN) {
2019-05-12 08:17:56 -04:00
updneo_cleanup_job(job);
ERROR("Invalid spool format (block length %d)!\n", len);
return CUPS_BACKEND_CANCEL;
}
/* Behavior based on the various PDL blocks */
if (!strncmp("PJL-H", tok, 5)) {
job->hdrbuf = malloc(len);
if (!job->hdrbuf) {
ERROR("Memory allocation failure!\n");
updneo_cleanup_job(job);
return CUPS_BACKEND_RETRY_CURRENT;
}
ptr = job->hdrbuf;
lenptr = &job->hdrlen;
} else if (!strncmp("PJL-T", tok, 5)) {
job->ftrbuf = malloc(len);
if (!job->ftrbuf) {
ERROR("Memory allocation failure!\n");
updneo_cleanup_job(job);
return CUPS_BACKEND_RETRY_CURRENT;
}
ptr = job->ftrbuf;
lenptr = &job->ftrlen;
run = 0;
} else if (!strncmp("PDL", tok, 3)) {
job->databuf = malloc(len);
if (!job->databuf) {
ERROR("Memory allocation failure!\n");
updneo_cleanup_job(job);
return CUPS_BACKEND_RETRY_CURRENT;
}
ptr = job->databuf;
lenptr = &job->datalen;
} else {
ERROR("Unrecognized PDL type '%s'\n", tok);
updneo_cleanup_job(job);
return CUPS_BACKEND_CANCEL;
}
// DEBUG("Read block '%s' @ %d ...\n", tok, job->datalen);
// DEBUG("...len '%d'\n", len);
// parse the rest?
// 898MD: 6,0,0,0
// D80MD: 4
// CR20L: 64,0,0,0
/* Read in the data chunk */
while(len > 0) {
i = read(data_fd, ptr + *lenptr, len);
if (i < 0) {
updneo_cleanup_job(job);
return CUPS_BACKEND_CANCEL;
}
if (i == 0)
break;
*lenptr += i;
len -= i;
}
}
if (!job->datalen || !job->hdrlen || !job->ftrlen) {
if (job->datalen + job->hdrlen + job->ftrlen) {
ERROR("Necessary block missing!\n");
}
updneo_cleanup_job(job);
return CUPS_BACKEND_CANCEL;
}
/* Sanity check job parameters */
/* Validate against max print size in SCSYI */
{
char w[5], h[5];
uint16_t mw, mh;
uint16_t jw, jh;
memcpy(w, ctx->sts.scsyi, 4);
h[4] = 0;
memcpy(h, ctx->sts.scsyi + 4, 4);
w[4] = 0;
if (ctx->conn->type == P_SONY_UPD898) {
mw = strtol(h, NULL, 16);
mh = strtol(w, NULL, 16);
} else {
mw = strtol(w, NULL, 16);
mh = strtol(h, NULL, 16);
}
if (ctx->conn->type == P_SONY_UPDR80) {
memcpy(&jw, job->databuf + 84, 2);
memcpy(&jh, job->databuf + 84 + 2, 2);
} else {
memcpy(&jw, job->databuf + 40, 2);
memcpy(&jh, job->databuf + 40 + 2, 2);
}
jw = be16_to_cpu(jw);
jh = be16_to_cpu(jh);
if (mw && mh && (jw > mw || jh > mh)) {
ERROR("Job (%d/%d) exceeds max dimensions(%d/%d)\n",
jw,jh,mw,mh);
updneo_cleanup_job(job);
return CUPS_BACKEND_CANCEL;
}
}
// XXX Check vs loaded media type (ctx->marker.numtype?)
2020-11-08 12:22:25 -05:00
// XXX set job copies to max(job, parameter)?
/* Find copy offset */
for (int i = 0 ; i < 312 ; i++ ) {
if (job->databuf[i] == 0x02 &&
job->databuf[i+1] == 0x00 &&
job->databuf[i+2] == 0x09) {
job->databuf[i+4] = copies;
break;
}
}
job->copies = 1; /* Printer makes copies */
*vjob = job;
return CUPS_BACKEND_OK;
}
static int dlen;
static struct deviceid_dict dict[MAX_DICT];
static int updneo_get_status(struct updneo_ctx *ctx)
{
char *ieee_id = get_device_id(ctx->conn->dev, ctx->conn->iface);
int i;
if (!ieee_id)
return CUPS_BACKEND_FAILED;
/* Don't forget to log! */
if (dyesub_debug >= 1) {
2019-11-05 17:40:12 -05:00
DEBUG("IEEE1284: %s\n", ieee_id);
}
dlen = parse1284_data(ieee_id, dict);
/* Parse out data */
for (i = 0; i < dlen ; i++) {
if (!strcmp("SCDIV", dict[i].key)) {
ctx->sts.scdiv = strtol(dict[i].val, NULL, 16);
} else if (!strcmp("SCSYV", dict[i].key)) {
ctx->sts.scsyv = strtol(dict[i].val, NULL, 16);
} else if (!strcmp("SCSNO", dict[i].key)) {
strncpy(ctx->sts.scsno, dict[i].val, sizeof(ctx->sts.scsno) - 1);
/* Trim trailing '-'s off of serial number (UP-D898)*/
for (int i = 0; i < (int) sizeof(ctx->sts.scsno); i++) {
if (ctx->sts.scsno[i] == '-') {
ctx->sts.scsno[i] = 0;
break;
}
}
} else if (!strcmp("SCSYS", dict[i].key)) {
strncpy(ctx->sts.scsys, dict[i].val, sizeof(ctx->sts.scsys) - 1);
} else if (!strcmp("SCMDS", dict[i].key)) {
int j;
char buf[5];
buf[4] = 0;
for (j = 0 ; j < 5 ; j++) {
memcpy(buf, dict[i].val + (4*j), 4);
ctx->sts.scmds[j] = strtol(buf, NULL, 16);
}
} else if (!strcmp("SCPRS", dict[i].key)) {
ctx->sts.scprs = strtol(dict[i].val, NULL, 16);
} else if (!strcmp("SCSES", dict[i].key)) {
ctx->sts.scses = strtol(dict[i].val, NULL, 16);
} else if (!strcmp("SCWTS", dict[i].key)) {
ctx->sts.scwts = strtol(dict[i].val, NULL, 16);
} else if (!strcmp("SCJBS", dict[i].key)) {
ctx->sts.scjbs = strtol(dict[i].val, NULL, 16);
} else if (!strcmp("SCSYE", dict[i].key)) {
ctx->sts.scsye = strtol(dict[i].val, NULL, 16);
} else if (!strcmp("SCMDE", dict[i].key)) {
ctx->sts.scmde = strtol(dict[i].val, NULL, 16);
} else if (!strcmp("SCMCE", dict[i].key)) {
ctx->sts.scmce = strtol(dict[i].val, NULL, 16);
} else if (!strcmp("SCJBI", dict[i].key)) {
strncpy(ctx->sts.scjbi, dict[i].val, sizeof(ctx->sts.scjbi) - 1);
} else if (!strcmp("SCSYI", dict[i].key)) {
strncpy(ctx->sts.scsyi, dict[i].val, sizeof(ctx->sts.scsyi) - 1);
} else if (!strcmp("SCSVI", dict[i].key)) {
int j;
char buf[7];
buf[6] = 0;
2019-11-07 12:34:21 -05:00
for (j = 0 ; j < 2 ; j++) {
memcpy(buf, dict[i].val + (6*j), 6);
ctx->sts.scsvi[j] = strtol(buf, NULL, 16);
}
} else if (!strcmp("SCMNI", dict[i].key)) {
int j;
char buf[7];
buf[6] = 0;
2019-11-07 12:34:21 -05:00
for (j = 0 ; j < 2 ; j++) {
memcpy(buf, dict[i].val + (6*j), 6);
ctx->sts.scmni[j] = strtol(buf, NULL, 16);
}
} else if (!strcmp("SCCAI", dict[i].key)) {
strncpy(ctx->sts.sccai, dict[i].val, sizeof(ctx->sts.sccai) - 1);
} else if (!strcmp("SCGAI", dict[i].key)) {
ctx->sts.scgai = strtol(dict[i].val, NULL, 16);
} else if (!strcmp("SCGSI", dict[i].key)) {
ctx->sts.scgsi = strtol(dict[i].val, NULL, 16);
} else if (!strcmp("SCMDI", dict[i].key)) {
ctx->sts.scmdi = strtol(dict[i].val, NULL, 16);
} else if (!strcmp("SCQTI", dict[i].key)) {
ctx->sts.scqti = strtol(dict[i].val, NULL, 16);
} else if (!strcmp("SPUQI", dict[i].key)) {
ctx->sts.spuqi = strtol(dict[i].val, NULL, 16);
} else if (!strcmp("MFG", dict[i].key) ||
!strcmp("MDL", dict[i].key) ||
!strcmp("DES", dict[i].key) ||
!strcmp("CMD", dict[i].key) ||
!strcmp("CLS", dict[i].key)) {
/* Ignore standard IEEE1284 attributes! */
} else {
if (!strncmp("SC", dict[i].key, 2) && !strncmp("SP", dict[i].key, 2))
DEBUG("Extra/Unknown IEEE1284 field '%s' = '%s'\n",
dict[i].key, dict[i].val);
}
};
/* Clean up */
if (ieee_id) free(ieee_id);
while (dlen--) {
free (dict[dlen].key);
free (dict[dlen].val);
}
return CUPS_BACKEND_OK;
}
static void updneo_dump_status(struct updneo_ctx *ctx, struct updneo_sts *sts)
{
/* Dump status */
INFO("Serial Number: %s\n", sts->scsno);
INFO("Firmware Version: %02x.%02x.%02x.%02x\n",
(sts->scsyv >> 24) & 0xff,
(sts->scsyv >> 16) & 0xff,
(sts->scsyv >> 8) & 0xff,
(sts->scsyv >> 0) & 0xff);
INFO("Media type: %s\n", updneo_medias(sts->scmdi));
if (ctx->conn->type == P_SONY_UPDR80)
INFO("Remaining prints: %u/50\n", sts->scmds[4]);
INFO("Print count: %u\n", sts->scsvi[0]);
/* If the printer reports an error, pass it on */
if (sts->scmde || sts->scmce || sts->scsye) {
ERROR("Printer error: %s (MD=%04x, MC=%02x, SY=%02x)\n",
updneo_decode_errors(sts->scmde, sts->scmce, sts->scsye),
sts->scmde, sts->scmce, sts->scsye);
}
}
static int updneo_main_loop(void *vctx, const void *vjob) {
struct updneo_ctx *ctx = vctx;
int ret;
int copies;
const struct updneo_printjob *job = vjob;
if (!ctx)
return CUPS_BACKEND_FAILED;
if (!job)
return CUPS_BACKEND_FAILED;
copies = job->copies;
top:
/* Query printer status */
if ((ret = updneo_get_status(ctx))) {
return ret;
}
/* If the printer reports an error, bail */
if (ctx->sts.scmde || ctx->sts.scmce || ctx->sts.scsye) {
ERROR("Printer error: %s (MD=%04x, MC=%02x, SY=%02x)\n",
updneo_decode_errors(ctx->sts.scmde, ctx->sts.scmce, ctx->sts.scsye),
ctx->sts.scmde, ctx->sts.scmce, ctx->sts.scsye);
return CUPS_BACKEND_STOP;
}
/* Wait for the printer to become idle */
if (ctx->sts.scprs) {
sleep(1);
goto top;
}
/* Send over header */
if ((ret = send_data(ctx->conn,
job->hdrbuf, job->hdrlen)))
return CUPS_BACKEND_FAILED;
/* Send over data */
if ((ret = send_data(ctx->conn,
job->databuf, job->datalen)))
return CUPS_BACKEND_FAILED;
/* Send over footer */
if ((ret = send_data(ctx->conn,
job->ftrbuf, job->ftrlen)))
return CUPS_BACKEND_FAILED;
/* Wait for completion! */
retry:
sleep(1);
if ((ret = updneo_get_status(ctx))) {
return ret;
}
/* If the printer reports an error, bail */
if (ctx->sts.scmde || ctx->sts.scmce || ctx->sts.scsye) {
ERROR("Printer error: %s (MD=%04x, MC=%02x, SY=%02x)\n",
updneo_decode_errors(ctx->sts.scmde, ctx->sts.scmce, ctx->sts.scsye),
ctx->sts.scmde, ctx->sts.scmce, ctx->sts.scsye);
return CUPS_BACKEND_STOP;
}
/* See if we're busy... */
if (ctx->sts.scprs != 0) {
if (fast_return) {
INFO("Fast return mode enabled.\n");
} else {
goto retry;
}
}
/* Clean up */
if (terminate)
copies = 1;
INFO("Print complete (%d copies remaining)\n", copies - 1);
if (copies && --copies) {
goto top;
}
/* Needed by the UP-D898! But should be safe for
all models */
libusb_reset_device(ctx->conn->dev);
return CUPS_BACKEND_OK;
}
static void updneo_cmdline(void)
{
DEBUG("\t\t[ -s ] # Query status\n");
}
static int updneo_cmdline_arg(void *vctx, int argc, char **argv)
{
struct updneo_ctx *ctx = vctx;
int i, j = 0;
if (!ctx)
return -1;
while ((i = getopt(argc, argv, GETOPT_LIST_GLOBAL "s")) >= 0) {
switch(i) {
GETOPT_PROCESS_GLOBAL
case 's':
j = updneo_get_status(ctx);
if (!j)
updneo_dump_status(ctx, &ctx->sts);
break;
}
if (j) return j;
}
return CUPS_BACKEND_OK;
}
static int updneo_query_serno(struct dyesub_connection *conn, char *buf, int buf_len)
{
int ret;
char *ptr;
struct updneo_ctx ctx = {
.conn = conn,
};
if ((ret = updneo_get_status(&ctx))) {
return ret;
}
ptr = ctx.sts.scsno;
2019-11-17 20:54:08 -05:00
while (*ptr == 0x30) ptr++;
strncpy(buf, ptr, buf_len);
buf[buf_len-1] = 0;
return CUPS_BACKEND_OK;
}
static int updneo_query_markers(void *vctx, struct marker **markers, int *count)
{
struct updneo_ctx *ctx = vctx;
int ret;
*markers = &ctx->marker;
*count = 1;
/* Query printer status */
if ((ret = updneo_get_status(ctx))) {
return ret;
}
if (ctx->conn->type != P_SONY_UPD898) {
ctx->marker.levelnow = ctx->sts.scmds[4];
}
return CUPS_BACKEND_OK;
}
static const char *sonyupdneo_prefixes[] = {
"sonyupdneo", /* Family Name */
"dnp-sl20", // extra, unknown if shared with CR20L
NULL
};
/* Exported */
#define USB_VID_SONY 0x054C
#define USB_PID_SONY_UPD898MD 0x0877 // 0x589a?
#define USB_PID_SONY_UPCR20L 0xbcde
#define USB_PID_SONY_UPDR80MD 0x03c3
#define USB_PID_STRYKER_SDP1000 0x03c4
#define USB_PID_SONY_UPDR80 0x03c5
#define USB_PID_SONY_UPCX1 0x02d4
const struct dyesub_backend sonyupdneo_backend = {
.name = "Sony UP-D Neo",
2020-11-08 12:22:25 -05:00
.version = "0.14",
.flags = BACKEND_FLAG_BADISERIAL, /* UP-D898MD at least */
.uri_prefixes = sonyupdneo_prefixes,
.cmdline_arg = updneo_cmdline_arg,
.cmdline_usage = updneo_cmdline,
.init = updneo_init,
.attach = updneo_attach,
.cleanup_job = updneo_cleanup_job,
.read_parse = updneo_read_parse,
.main_loop = updneo_main_loop,
.query_markers = updneo_query_markers,
.query_serno = updneo_query_serno,
.devices = {
{ USB_VID_SONY, USB_PID_SONY_UPD898MD, P_SONY_UPD898, NULL, "sony-upd898"},
{ USB_VID_SONY, USB_PID_SONY_UPCR20L, P_SONY_UPCR20L, NULL, "sony-upcr20l"},
{ USB_VID_SONY, USB_PID_SONY_UPDR80, P_SONY_UPDR80, NULL, "sony-updr80"},
2019-04-20 19:55:36 -04:00
{ USB_VID_SONY, USB_PID_SONY_UPDR80MD, P_SONY_UPDR80, NULL, "sony-updr80md"},
{ USB_VID_SONY, USB_PID_STRYKER_SDP1000, P_SONY_UPDR80, NULL, "stryker-sdp1000"},
{ 0, 0, 0, NULL, NULL}
}
};
/* Sony UP-D (new) printer spool format
Covers UP-CR20L, UP-DR80/DR80MD, UP-D898/UP-X898
HP-PJL wrapper around custom Sony PDL:
JOBSIZE=PJL-H,size,arg1,arg2,etc [null terminated, padded to 256 bytes]
[ size bytes of PJL header! ]