selphy_print/backend_shinkos2145.c

1733 lines
43 KiB
C
Raw Normal View History

/*
* Shinko/Sinfonia CHC-S2145 CUPS backend -- libusb-1.0 version
*
* (c) 2013-2019 Solomon Peachy <pizza@shaftnet.org>
*
* Development of this backend was sponsored by:
2013-12-17 08:30:37 -05:00
*
* LiveLink Technology [ www.livelinktechnology.net ]
2013-12-17 08:30:37 -05:00
*
* The latest version of this program can be found at:
*
* http://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, 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]
*
* SPDX-License-Identifier: GPL-3.0+
*
*/
#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 BACKEND shinkos2145_backend
#include "backend_common.h"
#include "backend_shinko.h"
enum {
S_IDLE = 0,
S_PRINTER_READY_CMD,
S_PRINTER_SENT_DATA,
S_FINISHED,
};
#if 0
/* Structure of printjob header. All fields are LITTLE ENDIAN */
struct s2145_printjob_hdr {
uint32_t len1; /* Fixed at 0x10 */
2014-10-19 09:10:10 -04:00
uint32_t model; /* Equal to the printer model (eg '2145' or '1245' decimal) */
uint32_t unk2;
2014-10-19 09:10:10 -04:00
uint32_t unk3; /* Fixed at 0x01 */
uint32_t len2; /* Fixed at 0x64 */
uint32_t unk5;
uint32_t media;
uint32_t unk6;
uint32_t method;
uint32_t oc_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));
#endif
/* 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
static char *cmd_names(uint16_t v) {
switch (le16_to_cpu(v)) {
case S2145_CMD_STATUS:
return "Get Status";
case S2145_CMD_MEDIAINFO:
return "Get Media Info";
case S2145_CMD_MODELNAME:
return "Get Model Name";
case S2145_CMD_ERRORLOG:
return "Get Error Log";
case S2145_CMD_PRINTJOB:
return "Print";
case S2145_CMD_CANCELJOB:
return "Cancel Print";
case S2145_CMD_FLASHLED:
return "Flash LEDs";
case S2145_CMD_RESET:
return "Reset";
case S2145_CMD_READTONE:
return "Read Tone Curve";
case S2145_CMD_BUTTON:
return "Button Enable";
case S2145_CMD_GETUNIQUE:
return "Get Unique String";
case S2145_CMD_FWINFO:
return "Get Firmware Info";
case S2145_CMD_UPDATE:
return "Update";
case S2145_CMD_SETUNIQUE:
return "Set Unique String";
default:
return "Unknown Command";
}
2016-12-15 09:37:31 -05:00
}
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));
#define PRINT_MEDIA_4x6 0x00
#define PRINT_MEDIA_5x3_5 0x01
#define PRINT_MEDIA_5x7 0x03
#define PRINT_MEDIA_6x9 0x05
#define PRINT_MEDIA_6x8 0x06
#define PRINT_MEDIA_2x6 0x07
static char *print_sizes (uint8_t v) {
switch (v) {
case PRINT_MEDIA_4x6:
return "4x6";
case PRINT_MEDIA_5x3_5:
return "5x3.5";
case PRINT_MEDIA_5x7:
return "5x7";
case PRINT_MEDIA_6x9:
return "6x9";
case PRINT_MEDIA_6x8:
return "6x8";
case PRINT_MEDIA_2x6:
return "2x6";
default:
return "Unknown";
}
}
static int print_counts (uint8_t v) {
switch (v) {
case PRINT_MEDIA_4x6:
return 700;
case PRINT_MEDIA_5x3_5:
return 800;
case PRINT_MEDIA_5x7:
return 400;
case PRINT_MEDIA_6x9:
return 310;
case PRINT_MEDIA_6x8:
return 350;
default:
return 700;
}
}
#define PRINT_MODE_DEFAULT 0x01
#define PRINT_MODE_STD_GLOSSY 0x02
#define PRINT_MODE_FINE_GLOSSY 0x03
#define PRINT_MODE_STD_MATTE 0x04
#define PRINT_MODE_FINE_MATTE 0x05
#define PRINT_MODE_STD_EGLOSSY 0x06
#define PRINT_MODE_FINE_EGLOSSY 0x07
#if 0
static char *print_modes(uint8_t v) {
switch (v) {
case PRINT_MODE_DEFAULT:
return "Default";
case PRINT_MODE_STD_GLOSSY:
return "Std Glossy";
case PRINT_MODE_FINE_GLOSSY:
return "Fine Glossy";
case PRINT_MODE_STD_MATTE:
return "Std Matte";
case PRINT_MODE_FINE_MATTE:
return "Fine Matte";
case PRINT_MODE_STD_EGLOSSY:
return "Std ExGlossy";
case PRINT_MODE_FINE_EGLOSSY:
return "Fine ExGlossy";
default:
return "Unknown";
}
}
#endif
#define PRINT_METHOD_STD 0x00
#define PRINT_METHOD_4x6_2UP 0x02
#define PRINT_METHOD_2x6_2UP 0x04
2017-07-10 20:15:56 -04:00
static char *print_methods (uint8_t v) {
switch (v) {
case PRINT_METHOD_STD:
return "Standard";
case PRINT_METHOD_4x6_2UP:
return "4x6 2up";
case PRINT_METHOD_2x6_2UP:
return "2x6 2up";
default:
return "Unknown";
}
}
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));
#define RESET_PRINTER 0x03
#define RESET_USER_CURVE 0x04
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));
#define BUTTON_ENABLED 0x01
#define BUTTON_DISABLED 0x00
struct s2145_fwinfo_cmd {
struct s2145_cmd_hdr hdr;
uint8_t target;
} __attribute__((packed));
#define FWINFO_TARGET_MAIN_BOOT 0x01
#define FWINFO_TARGET_MAIN_APP 0x02
#define FWINFO_TARGET_DSP_BOOT 0x03
#define FWINFO_TARGET_DSP_APP 0x04
#define FWINFO_TARGET_USB_BOOT 0x05
#define FWINFO_TARGET_USB_APP 0x06
#define FWINFO_TARGET_TABLES 0x07
static char *fwinfo_targets (uint8_t v) {
switch (v) {
case FWINFO_TARGET_MAIN_BOOT:
return "Main Boot";
case FWINFO_TARGET_MAIN_APP:
return "Main App ";
case FWINFO_TARGET_DSP_BOOT:
return "DSP Boot ";
case FWINFO_TARGET_DSP_APP:
return "DSP App ";
case FWINFO_TARGET_USB_BOOT:
return "USB Boot ";
case FWINFO_TARGET_USB_APP:
return "USB App ";
2017-07-10 20:15:56 -04:00
case FWINFO_TARGET_TABLES:
return "Tables ";
default:
return "Unknown ";
}
}
struct s2145_update_cmd {
struct s2145_cmd_hdr hdr;
uint8_t target;
uint32_t reserved;
uint32_t size;
} __attribute__((packed));
#define UPDATE_SIZE 0x600
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
static char *error_codes(uint8_t major, uint8_t minor)
{
switch(major) {
case 0x01: /* "Controller Error" */
switch(minor) {
case 0x01:
return "Controller: EEPROM Write Timeout";
case 0x02:
return "Controller: EEPROM Verify";
case 0x04:
return "Controller: DSP Inactive";
case 0x05:
return "Controller: DSP Application Inactive";
case 0x06:
return "Controller: Main FW Data";
case 0x07:
return "Controller: Main FW Write";
case 0x08:
return "Controller: DSP FW Data";
case 0x09:
return "Controller: DSP FW Write";
case 0x0A:
return "Controller: 0A ASIC??";
case 0x0B:
return "Controller: 0B FPGA??";
case 0x0D:
return "Controller: Tone Curve Write";
case 0x16:
return "Controller: Invalid Parameter Table";
case 0x17:
return "Controller: Parameter Table Data";
case 0x18:
return "Controller: Parameter Table Write";
case 0x29:
return "Controller: DSP Communication";
case 0x2A:
return "Controller: DSP DMA Failure";
default:
return "Controller: Unknown";
}
case 0x02: /* "Mechanical Error" */
switch (minor) {
case 0x01:
return "Mechanical: Thermal Head (Upper Up)";
case 0x02:
return "Mechanical: Thermal Head (Head Up)";
case 0x03:
return "Mechanical: Thermal Head (Head Down)";
case 0x04:
return "Mechanical: Pinch Roller (Initialize)";
case 0x05:
return "Mechanical: Pinch Roller (Mode1)";
case 0x06:
return "Mechanical: Pinch Roller (Mode2)";
case 0x07:
return "Mechanical: Pinch Roller (Mode3)";
case 0x08:
return "Mechanical: Pinch Roller (Mode4)";
case 0x09:
return "Mechanical: Cutter (Right)";
case 0x0A:
return "Mechanical: Cutter (Left)";
case 0x0B:
return "Mechanical: Thermal Head (Head Down Recovery)";
default:
return "Mechanical: Unknown";
}
case 0x03: /* "Sensor Error" */
switch (minor) {
case 0x01:
return "Sensor: Thermal Head";
case 0x02:
return "Sensor: Pinch Roller";
case 0x03:
return "Sensor: Cutter Left";
case 0x04:
return "Sensor: Cutter Right";
case 0x05:
return "Sensor: Cutter Unknown";
case 0x08:
return "Sensor: Ribbon Encoder (Supply)";
case 0x09:
return "Sensor: Ribbon Encoder (Takeup)";
case 0x13:
return "Sensor: Thermal Head";
default:
return "Sensor: Unknown";
}
case 0x04: /* "Temperature Sensor Error" */
switch (minor) {
case 0x01:
return "Temp Sensor: Thermal Head High";
case 0x02:
return "Temp Sensor: Thermal Head Low";
case 0x03:
return "Temp Sensor: Environment High";
case 0x04:
return "Temp Sensor: Environment Low";
case 0x05:
return "Temp Sensor: Warmup Timed Out";
default:
return "Temp Sensor: Unknown";
}
case 0x5: /* "Paper Jam" */
switch (minor) {
case 0x01:
return "Paper Jam: Loading Leading Edge Off";
case 0x02:
return "Paper Jam: Loading Print Position On";
case 0x03:
return "Paper Jam: Loading Print Position Off";
case 0x04:
return "Paper Jam: Loading Print Position On";
case 0x05:
return "Paper Jam: Loading Leading Edge On";
case 0x11:
return "Paper Jam: Initializing Print Position Off";
case 0x12:
return "Paper Jam: Initializing Print Position On";
case 0x13:
return "Paper Jam: Initializing Leading Edge On";
case 0x14:
return "Paper Jam: Initializing Print Position On";
case 0x15:
return "Paper Jam: Initializing Print Position Off";
case 0x16:
return "Paper Jam: Initializing Print Position On";
case 0x21:
return "Paper Jam: Initializing Print Position On";
case 0x22:
return "Paper Jam: Rewinding Print Position On";
case 0x40:
return "Paper Jam: Pre-Printing Print Position Off";
case 0x41:
return "Paper Jam: Pre-Printing Print Position Off";
case 0x42:
return "Paper Jam: Printing Leading Edge Off";
case 0x43:
return "Paper Jam: After Returning Lead Edge Off";
case 0x44:
return "Paper Jam: After Printing Print Position Off";
case 0x45:
return "Paper Jam: After Printing Print Position On";
case 0x46:
return "Paper Jam: After Printing Print Position On";
case 0x47:
return "Paper Jam: After Printing Print Position Off";
case 0x49:
return "Paper Jam: Printing Lost Ribbon Mark";
case 0x4A:
return "Paper Jam: Printing Ribbon Cut";
case 0x4D:
return "Paper Jam: Printing Lost M Mark";
case 0x4E:
return "Paper Jam: Printing Lost C Mark";
case 0x4F:
return "Paper Jam: Printing Lost OP Mark";
case 0x61:
return "Paper Jam: Initializing Lead Edge On";
case 0x62:
return "Paper Jam: Initizlizing Print Position On";
case 0x64:
return "Paper Jam: Initizlizing Paper Size On";
default:
return "Paper Jam: Unknown";
}
case 0x06: /* User Error */
switch (minor) {
case 0x01:
return "Front Cover Open";
case 0x02:
return "Incorrect Ribbon";
case 0x03:
return "No Ribbon";
case 0x04:
return "Mismatched Ribbon";
case 0x05:
return "Mismatched Paper";
case 0x06:
return "Paper Empty";
case 0x08:
return "No Paper";
case 0x09:
return "Take Out Paper";
case 0x0A:
return "Cover Open Error";
case 0x0B:
return "Thermal Head Damaged";
case 0x0C:
return "Thermal Head Recovery";
default:
return "Unknown";
}
default:
2013-07-25 18:19:24 -04:00
return "Unknown";
}
}
static char *error_str(uint8_t v) {
switch (v) {
case ERROR_NONE:
return "None";
case ERROR_INVALID_PARAM:
return "Invalid Command Parameter";
case ERROR_MAIN_APP_INACTIVE:
return "Main App Inactive";
case ERROR_COMMS_TIMEOUT:
return "Main Communication Timeout";
case ERROR_MAINT_NEEDED:
return "Maintenance Needed";
case ERROR_BAD_COMMAND:
return "Inappropriate Command";
case ERROR_PRINTER:
return "Printer Error";
case ERROR_BUFFER_FULL:
return "Buffer Full";
default:
return "Unknown";
}
}
#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_OP 0x69
#define STATUS_PAPER_CUT 0x6A
#define STATUS_PAPER_EJECT 0x6B
#define STATUS_BACK_FEED_E 0x6C
#define STATUS_FINISHED 0x6D
static char *status_str(uint8_t v) {
switch (v) {
case STATUS_READY:
return "Ready";
case STATUS_INIT_CPU:
return "Initializing CPU";
case STATUS_INIT_RIBBON:
return "Initializing Ribbon";
case STATUS_INIT_PAPER:
return "Loading Paper";
case STATUS_THERMAL_PROTECT:
return "Thermal Protection";
case STATUS_USING_PANEL:
return "Using Operation Panel";
case STATUS_SELF_DIAG:
return "Processing Self Diagnosis";
case STATUS_DOWNLOADING:
return "Processing Download";
case STATUS_FEEDING_PAPER:
return "Feeding Paper";
case STATUS_PRE_HEAT:
return "Pre-Heating";
case STATUS_PRINT_Y:
return "Printing Yellow";
case STATUS_BACK_FEED_Y:
2013-07-16 23:35:34 -04:00
return "Back-Feeding - Yellow Complete";
case STATUS_PRINT_M:
return "Printing Magenta";
case STATUS_BACK_FEED_M:
2013-07-16 23:35:34 -04:00
return "Back-Feeding - Magenta Complete";
case STATUS_PRINT_C:
return "Printing Cyan";
case STATUS_BACK_FEED_C:
2013-07-16 23:35:34 -04:00
return "Back-Feeding - Cyan Complete";
case STATUS_PRINT_OP:
return "Laminating";
case STATUS_PAPER_CUT:
return "Cutting Paper";
case STATUS_PAPER_EJECT:
return "Ejecting Paper";
case STATUS_BACK_FEED_E:
2013-07-16 23:35:34 -04:00
return "Back-Feeding - Ejected";
case STATUS_FINISHED:
2013-07-16 23:35:34 -04:00
return "Print Finished";
case ERROR_PRINTER:
return "Printer Error";
default:
return "Unknown";
}
}
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));
struct s2145_readtone_resp {
struct s2145_status_hdr hdr;
uint16_t total_size;
} __attribute__((packed));
struct s2145_mediainfo_item {
uint8_t code;
uint16_t columns;
uint16_t rows;
uint8_t media_type;
uint8_t print_method;
uint8_t reserved[3];
} __attribute__((packed));
#define MEDIA_TYPE_UNKNOWN 0x00
#define MEDIA_TYPE_PAPER 0x01
static char *media_types(uint8_t v) {
switch (v) {
case MEDIA_TYPE_UNKNOWN:
return "Unknown";
case MEDIA_TYPE_PAPER:
return "Paper";
default:
return "Unknown";
}
}
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_errorlog_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 minor;
uint16_t checksum;
} __attribute__((packed));
struct s2145_getunique_resp {
struct s2145_status_hdr hdr;
uint8_t data[24]; /* Not necessarily all used. */
} __attribute__((packed));
/* Private data structure */
struct shinkos2145_ctx {
struct libusb_device_handle *dev;
uint8_t endp_up;
uint8_t endp_down;
uint8_t jobid;
int type;
struct s2145_mediainfo_resp media;
struct marker marker;
int media_code;
};
#define READBACK_LEN 128 /* Needs to be larger than largest response hdr */
#define CMDBUF_LEN sizeof(struct s2145_print_cmd)
static uint8_t rdbuf[READBACK_LEN];
static int s2145_do_cmd(struct shinkos2145_ctx *ctx,
uint8_t *cmd, int cmdlen,
int minlen, int *num)
{
int ret;
struct s2145_status_hdr *resp = (struct s2145_status_hdr *) rdbuf;
libusb_device_handle *dev = ctx->dev;
uint8_t endp_up = ctx->endp_up;
uint8_t endp_down = ctx->endp_down;