summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorRémi Berthoz <[email protected]>2026-01-04 16:55:43 +0100
committerRémi Berthoz <[email protected]>2026-01-04 16:55:43 +0100
commitcab1b2f6f741ea151e87f139b2115d5234228bbd (patch)
tree6dc6919379d01d30b5df91619f56e8c8e855e6bd /src
parent3eafddb02a3347873dc1816f53b428518eb97c61 (diff)
Implement Printer Device Class
Diffstat (limited to 'src')
-rw-r--r--src/CMakeLists.txt1
-rw-r--r--src/class/printer/printer.h277
-rw-r--r--src/class/printer/printer_device.c306
-rw-r--r--src/class/printer/printer_device.h79
-rw-r--r--src/device/usbd.c13
-rw-r--r--src/device/usbd.h15
-rw-r--r--src/tinyusb.mk1
-rw-r--r--src/tusb.h4
-rw-r--r--src/tusb_option.h4
9 files changed, 700 insertions, 0 deletions
diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt
index 48dc75e50..00f466007 100644
--- a/src/CMakeLists.txt
+++ b/src/CMakeLists.txt
@@ -19,6 +19,7 @@ function(tinyusb_sources_get OUTPUT_VAR)
${CMAKE_CURRENT_FUNCTION_LIST_DIR}/class/mtp/mtp_device.c
${CMAKE_CURRENT_FUNCTION_LIST_DIR}/class/net/ecm_rndis_device.c
${CMAKE_CURRENT_FUNCTION_LIST_DIR}/class/net/ncm_device.c
+ ${CMAKE_CURRENT_FUNCTION_LIST_DIR}/class/printer/printer_device.c
${CMAKE_CURRENT_FUNCTION_LIST_DIR}/class/usbtmc/usbtmc_device.c
${CMAKE_CURRENT_FUNCTION_LIST_DIR}/class/vendor/vendor_device.c
${CMAKE_CURRENT_FUNCTION_LIST_DIR}/class/video/video_device.c
diff --git a/src/class/printer/printer.h b/src/class/printer/printer.h
new file mode 100644
index 000000000..4cd1d62fc
--- /dev/null
+++ b/src/class/printer/printer.h
@@ -0,0 +1,277 @@
+#include <stdint.h>
+#include "tusb_option.h"
+
+#if (CFG_TUD_ENABLED && CFG_TUD_PRINTER)
+
+ #include "device/usbd.h"
+ #include "device/usbd_pvt.h"
+
+// #include "bsp/board_api.h"
+
+ #include "printer_device.h"
+ #include "printer.h"
+
+
+//--------------------------------------------------------------------+
+// MACRO CONSTANT TYPEDEF
+//--------------------------------------------------------------------+
+
+typedef struct {
+ uint8_t itf_num;
+ uint8_t ep_in;
+ uint8_t ep_out;
+ /*------------- From this point, data is not cleared by bus reset -------------*/
+
+ // FIFO
+ tu_fifo_t rx_ff;
+ tu_fifo_t tx_ff;
+
+ uint8_t rx_ff_buf[CFG_TUD_PRINTER_RX_BUFSIZE];
+ uint8_t tx_ff_buf[CFG_TUD_PRINTER_TX_BUFSIZE];
+
+ OSAL_MUTEX_DEF(rx_ff_mutex);
+ OSAL_MUTEX_DEF(tx_ff_mutex);
+} printer_interface_t;
+
+ #define ITF_MEM_RESET_SIZE offsetof(printer_interface_t, wanted_char)
+
+typedef struct {
+ TUD_EPBUF_DEF(epout, CFG_TUD_PRINTER_EP_BUFSIZE);
+ TUD_EPBUF_DEF(epin, CFG_TUD_PRINTER_EP_BUFSIZE);
+} printer_epbuf_t;
+
+static printer_interface_t _printer_itf[CFG_TUD_PRINTER];
+CFG_TUD_MEM_SECTION static printer_epbuf_t _printer_epbuf[CFG_TUD_PRINTER];
+
+
+//--------------------------------------------------------------------+
+// INTERNAL OBJECT & FUNCTION DECLARATION
+//--------------------------------------------------------------------+
+
+static tud_printer_configure_fifo_t _printer_fifo_cfg;
+
+static bool _prep_out_transaction(uint8_t itf) {
+ const uint8_t rhport = 0;
+ printer_interface_t *p_printer = &_printer_itf[itf];
+ printer_epbuf_t *p_epbuf = &_printer_epbuf[itf];
+
+ // Skip if usb is not ready yet
+ TU_VERIFY(tud_ready() && p_printer->ep_out);
+
+ uint16_t available = tu_fifo_remaining(&p_printer->rx_ff);
+
+ // Prepare for incoming data but only allow what we can store in the ring buffer.
+ // TODO Actually we can still carry out the transfer, keeping count of received bytes
+ // and slowly move it to the FIFO when read().
+ // This pre-check reduces endpoint claiming
+ TU_VERIFY(available >= CFG_TUD_PRINTER_EP_BUFSIZE);
+
+ // claim endpoint
+ TU_VERIFY(usbd_edpt_claim(rhport, p_printer->ep_out));
+
+ // fifo can be changed before endpoint is claimed
+ available = tu_fifo_remaining(&p_printer->rx_ff);
+
+ if (available >= CFG_TUD_PRINTER_EP_BUFSIZE) {
+ return usbd_edpt_xfer(rhport, p_printer->ep_out, p_epbuf->epout, CFG_TUD_PRINTER_EP_BUFSIZE);
+ } else {
+ // Release endpoint since we don't make any transfer
+ usbd_edpt_release(rhport, p_printer->ep_out);
+ return false;
+ }
+}
+
+//--------------------------------------------------------------------+
+// APPLICATION API
+//--------------------------------------------------------------------+
+
+uint32_t tud_printer_n_available(uint8_t itf) {
+ return tu_fifo_count(&_printer_itf[itf].rx_ff);
+}
+
+uint32_t tud_printer_n_read(uint8_t itf, void *buffer, uint32_t bufsize) {
+ printer_interface_t *p_printer = &_printer_itf[itf];
+ uint32_t num_read = tu_fifo_read_n(&p_printer->rx_ff, buffer, (uint16_t)TU_MIN(bufsize, UINT16_MAX));
+ _prep_out_transaction(itf);
+ return num_read;
+}
+
+bool tud_printer_n_peek(uint8_t itf, uint8_t *chr) {
+ return tu_fifo_peek(&_printer_itf[itf].rx_ff, chr);
+}
+
+void tud_printer_n_read_flush(uint8_t itf) {
+ printer_interface_t *p_printer = &_printer_itf[itf];
+ tu_fifo_clear(&p_printer->rx_ff);
+ _prep_out_transaction(itf);
+}
+
+
+//--------------------------------------------------------------------+
+// USBD PRINTER DRIVER API
+//--------------------------------------------------------------------+
+
+void printer_init(void) {
+ tu_memclr(_printer_itf, sizeof(_printer_itf));
+ tu_memclr(&_printer_fifo_cfg, sizeof(_printer_fifo_cfg));
+
+ for (uint8_t i = 0; i < CFG_TUD_PRINTER; i++) {
+ printer_interface_t *p_printer = &_printer_itf[i];
+
+ tu_fifo_config(&p_printer->rx_ff, p_printer->rx_ff_buf, TU_ARRAY_SIZE(p_printer->rx_ff_buf), 1, false);
+ tu_fifo_config(&p_printer->tx_ff, p_printer->tx_ff_buf, TU_ARRAY_SIZE(p_printer->tx_ff_buf), 1, true);
+
+ #if OSAL_MUTEX_REQUIRED
+ osal_mutex_t mutex_rd = osal_mutex_create(&p_printer->rx_ff_mutex);
+ osal_mutex_t mutex_wr = osal_mutex_create(&p_printer->tx_ff_mutex);
+ TU_ASSERT(mutex_rd != NULL && mutex_wr != NULL, );
+
+ tu_fifo_config_mutex(&p_printer->rx_ff, NULL, mutex_rd);
+ tu_fifo_config_mutex(&p_printer->tx_ff, mutex_wr, NULL);
+ #endif
+ }
+}
+
+bool printer_deinit(void) {
+ #if OSAL_MUTEX_REQUIRED
+ for (uint8_t i = 0; i < CFG_TUD_PRINTER; i++) {
+ printer_interface_t *p_printer = &_printer_itf[i];
+ osal_mutex_t mutex_rd = p_printer->rx_ff.mutex_rd;
+ osal_mutex_t mutex_wr = p_printer->tx_ff.mutex_rd;
+
+ if (mutex_rd) {
+ osal_mutex_delete(mutex_rd);
+ tu_fifo_config_mutex(&p_printer->rx_ff, NULL, NULL);
+ }
+
+ if (mutex_wr) {
+ osal_mutex_delete(mutex_wr);
+ tu_fifo_config_mutex(&p_printer->tx_ff, NULL, NULL);
+ }
+ }
+ #endif
+
+ return true;
+}
+
+void printer_reset(uint8_t rhport) {
+ (void)rhport;
+
+ for (uint8_t i = 0; i < CFG_TUD_PRINTER; i++) {
+ printer_interface_t *p_printer = &_printer_itf[i];
+
+ tu_memclr(p_printer, sizeof(p_printer));
+ if (!_printer_fifo_cfg.rx_persistent) {
+ tu_fifo_clear(&p_printer->rx_ff);
+ }
+ if (!_printer_fifo_cfg.tx_persistent) {
+ tu_fifo_clear(&p_printer->tx_ff);
+ }
+ // tu_fifo_set_overwritable(&p_printer->rx_ff, true);
+ tu_fifo_set_overwritable(&p_printer->tx_ff, true);
+ }
+}
+
+uint16_t printer_open(uint8_t rhport, const tusb_desc_interface_t *itf_desc, uint16_t max_len) {
+ TU_VERIFY(TUSB_CLASS_PRINTER == itf_desc->bInterfaceClass, 0);
+
+ // Identify available interface to open
+ printer_interface_t *p_printer;
+ uint8_t printer_id;
+ for (printer_id = 0; printer_id < CFG_TUD_PRINTER; printer_id++) {
+ p_printer = &_printer_itf[printer_id];
+ if (p_printer->ep_out == 0) {
+ break;
+ }
+ }
+ TU_ASSERT(printer_id < CFG_TUD_PRINTER);
+
+ //------------- Interface -------------//
+ uint16_t drv_len = sizeof(tusb_desc_interface_t);
+
+ //------------- Endpoints -------------//
+ TU_ASSERT(itf_desc->bNumEndpoints == 2);
+ drv_len += 2 * sizeof(tusb_desc_endpoint_t);
+ p_printer->itf_num = 2;
+ const uint8_t *p_desc = tu_desc_next(itf_desc);
+ TU_ASSERT(usbd_open_edpt_pair(rhport, p_desc, 2, TUSB_XFER_BULK, &p_printer->ep_out, &p_printer->ep_in), 0);
+
+ _prep_out_transaction(printer_id);
+
+ return drv_len;
+}
+
+bool printer_control_xfer_cb(uint8_t rhport, uint8_t stage, const tusb_control_request_t *request) {
+ TU_VERIFY(request->bmRequestType_bit.recipient == TUSB_REQ_RCPT_INTERFACE);
+
+ if (request->bmRequestType_bit.type == TUSB_REQ_TYPE_STANDARD) {
+ //------------- STD Request -------------//
+ if (stage != CONTROL_STAGE_SETUP) {
+ return true;
+ }
+ } else if (request->bmRequestType_bit.type == TUSB_REQ_TYPE_CLASS) {
+ switch (request->bRequest) {
+ // https://www.usb.org/sites/default/files/usbprint11a021811.pdf
+ case PRINTER_REQ_CONTROL_GET_DEVICE_ID:
+ if (stage == CONTROL_STAGE_SETUP) {
+ const char deviceId[] = "MANUFACTURER:ACME Manufacturing;"
+ "MODEL:LaserBeam 9;"
+ "COMMAND SET:PS;"
+ "COMMENT:Anything you like;"
+ "ACTIVE COMMAND SET:PS;";
+ char buffer[256];
+ strcpy(buffer + 2, deviceId);
+ buffer[0] = 0x00;
+ buffer[1] = strlen(deviceId);
+ return tud_control_xfer(rhport, request, buffer, strlen(deviceId) + 2);
+ }
+ break;
+ case PRINTER_REQ_CONTROL_GET_PORT_STATUS:
+ if (stage == CONTROL_STAGE_SETUP) {
+ static uint8_t port_status = (0 << 3) | (1 << 1) | (1 << 2); // ~Paper empty + Selected + NoError
+ return tud_control_xfer(rhport, request, &port_status, sizeof(port_status));
+ }
+ break;
+ case PRINTER_REQ_CONTROL_SOFT_RESET:
+ if (stage == CONTROL_STAGE_SETUP) {
+ return false; // what to do ?
+ }
+ break;
+ default:
+ return false;
+ }
+ } else {
+ return false;
+ }
+ return true;
+}
+
+bool printer_xfer_cb(uint8_t rhport, uint8_t ep_addr, xfer_result_t result, uint32_t xferred_bytes) {
+ uint8_t itf;
+ printer_interface_t *p_printer;
+
+ // Identify which interface to use
+ for (itf = 0; itf < CFG_TUD_PRINTER; itf++) {
+ p_printer = &_printer_itf[itf];
+ if (ep_addr == p_printer->ep_out) {
+ break;
+ }
+ }
+ TU_ASSERT(itf < CFG_TUD_PRINTER);
+ printer_epbuf_t *p_epbuf = &_printer_epbuf[itf];
+
+ // Received new data
+ if (ep_addr == p_printer->ep_out) {
+ tu_fifo_write_n(&p_printer->rx_ff, p_epbuf->epout, (uint16_t)xferred_bytes);
+ // invoke receive callback (if there is still data)
+ if (tud_printer_rx_cb && !tu_fifo_empty(&p_printer->rx_ff)) {
+ tud_printer_rx_cb(itf, xferred_bytes);
+ }
+ // prepare for OUT transaction
+ _prep_out_transaction(itf);
+ }
+
+ return true;
+}
+
+#endif
diff --git a/src/class/printer/printer_device.c b/src/class/printer/printer_device.c
new file mode 100644
index 000000000..efeae100f
--- /dev/null
+++ b/src/class/printer/printer_device.c
@@ -0,0 +1,306 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2026 Ha Thach (tinyusb.org)
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ *
+ * This file is part of the TinyUSB stack.
+ */
+
+#include "tusb_option.h"
+
+#if (CFG_TUD_ENABLED && CFG_TUD_PRINTER)
+
+ //--------------------------------------------------------------------+
+ // INCLUDE
+ //--------------------------------------------------------------------+
+ #include "device/usbd.h"
+ #include "device/usbd_pvt.h"
+
+ #include "printer_device.h"
+
+//--------------------------------------------------------------------+
+// MACRO CONSTANT TYPEDEF
+//--------------------------------------------------------------------+
+
+typedef struct {
+ uint8_t itf_num;
+ uint8_t ep_out; // Bulk Out endpoint
+ uint8_t ep_in; // optional Bulk In endpoint
+
+ /*------------- From this point, data is not cleared by bus reset -------------*/
+
+ // FIFO
+ tu_fifo_t rx_ff;
+ tu_fifo_t tx_ff;
+
+ uint8_t rx_ff_buf[CFG_TUD_PRINTER_RX_BUFSIZE];
+ uint8_t tx_ff_buf[CFG_TUD_PRINTER_TX_BUFSIZE];
+
+ OSAL_MUTEX_DEF(rx_ff_mutex);
+ OSAL_MUTEX_DEF(tx_ff_mutex);
+} printer_interface_t;
+
+typedef struct {
+ TUD_EPBUF_DEF(epout, CFG_TUD_PRINTER_EP_BUFSIZE);
+ TUD_EPBUF_DEF(epin, CFG_TUD_PRINTER_EP_BUFSIZE);
+} printer_epbuf_t;
+
+static printer_interface_t _printer_itf[CFG_TUD_PRINTER];
+CFG_TUD_MEM_SECTION static printer_epbuf_t _printer_epbuf[CFG_TUD_PRINTER];
+
+
+//--------------------------------------------------------------------+
+// INTERNAL OBJECT & FUNCTION DECLARATION
+//--------------------------------------------------------------------+
+
+static tud_printer_configure_fifo_t _printer_fifo_cfg;
+
+static bool _prep_out_transaction(uint8_t itf) {
+ const uint8_t rhport = 0;
+ printer_interface_t *p_printer = &_printer_itf[itf];
+ printer_epbuf_t *p_epbuf = &_printer_epbuf[itf];
+
+ // Skip if usb is not ready yet
+ TU_VERIFY(tud_ready() && p_printer->ep_out);
+
+ uint16_t available = tu_fifo_remaining(&p_printer->rx_ff);
+
+ // Prepare for incoming data but only allow what we can store in the ring buffer.
+ // TODO Actually we can still carry out the transfer, keeping count of received bytes
+ // and slowly move it to the FIFO when read().
+ // This pre-check reduces endpoint claiming
+ TU_VERIFY(available >= CFG_TUD_PRINTER_EP_BUFSIZE);
+
+ // claim endpoint
+ TU_VERIFY(usbd_edpt_claim(rhport, p_printer->ep_out));
+
+ // fifo can be changed before endpoint is claimed
+ available = tu_fifo_remaining(&p_printer->rx_ff);
+
+ if (available >= CFG_TUD_PRINTER_EP_BUFSIZE) {
+ return usbd_edpt_xfer(rhport, p_printer->ep_out, p_epbuf->epout, CFG_TUD_PRINTER_EP_BUFSIZE);
+ } else {
+ // Release endpoint since we don't make any transfer
+ usbd_edpt_release(rhport, p_printer->ep_out);
+ return false;
+ }
+}
+
+//--------------------------------------------------------------------+
+// Weak stubs: invoked if no strong implementation is available
+//--------------------------------------------------------------------+
+TU_ATTR_WEAK void tud_printer_rx_cb(uint8_t itf, size_t n) {
+ (void)itf;
+ (void)n;
+}
+
+//--------------------------------------------------------------------+
+// APPLICATION API
+//--------------------------------------------------------------------+
+uint32_t tud_printer_n_available(uint8_t itf) {
+ return tu_fifo_count(&_printer_itf[itf].rx_ff);
+}
+
+uint32_t tud_printer_n_read(uint8_t itf, void *buffer, uint32_t bufsize) {
+ printer_interface_t *p_printer = &_printer_itf[itf];
+ uint32_t num_read = tu_fifo_read_n(&p_printer->rx_ff, buffer, (uint16_t)TU_MIN(bufsize, UINT16_MAX));
+ _prep_out_transaction(itf);
+ return num_read;
+}
+
+bool tud_printer_n_peek(uint8_t itf, uint8_t *chr) {
+ return tu_fifo_peek(&_printer_itf[itf].rx_ff, chr);
+}
+
+void tud_printer_n_read_flush(uint8_t itf) {
+ printer_interface_t *p_printer = &_printer_itf[itf];
+ tu_fifo_clear(&p_printer->rx_ff);
+ _prep_out_transaction(itf);
+}
+
+
+//--------------------------------------------------------------------+
+// USBD-CLASS API
+//--------------------------------------------------------------------+
+void printerd_init(void) {
+ tu_memclr(_printer_itf, sizeof(_printer_itf));
+ tu_memclr(&_printer_fifo_cfg, sizeof(_printer_fifo_cfg));
+
+ for (uint8_t i = 0; i < CFG_TUD_PRINTER; i++) {
+ printer_interface_t *p_printer = &_printer_itf[i];
+
+ tu_fifo_config(&p_printer->rx_ff, p_printer->rx_ff_buf, TU_ARRAY_SIZE(p_printer->rx_ff_buf), 1, false);
+ tu_fifo_config(&p_printer->tx_ff, p_printer->tx_ff_buf, TU_ARRAY_SIZE(p_printer->tx_ff_buf), 1, true);
+
+ #if OSAL_MUTEX_REQUIRED
+ osal_mutex_t mutex_rd = osal_mutex_create(&p_printer->rx_ff_mutex);
+ osal_mutex_t mutex_wr = osal_mutex_create(&p_printer->tx_ff_mutex);
+ TU_ASSERT(mutex_rd != NULL && mutex_wr != NULL, );
+
+ tu_fifo_config_mutex(&p_printer->rx_ff, NULL, mutex_rd);
+ tu_fifo_config_mutex(&p_printer->tx_ff, mutex_wr, NULL);
+ #endif
+ }
+}
+
+bool printerd_deinit(void) {
+ #if OSAL_MUTEX_REQUIRED
+ for (uint8_t i = 0; i < CFG_TUD_PRINTER; i++) {
+ printer_interface_t *p_printer = &_printer_itf[i];
+ osal_mutex_t mutex_rd = p_printer->rx_ff.mutex_rd;
+ osal_mutex_t mutex_wr = p_printer->tx_ff.mutex_rd;
+
+ if (mutex_rd) {
+ osal_mutex_delete(mutex_rd);
+ tu_fifo_config_mutex(&p_printer->rx_ff, NULL, NULL);
+ }
+
+ if (mutex_wr) {
+ osal_mutex_delete(mutex_wr);
+ tu_fifo_config_mutex(&p_printer->tx_ff, NULL, NULL);
+ }
+ }
+ #endif
+
+ return true;
+}
+
+void printerd_reset(uint8_t rhport) {
+ (void)rhport;
+
+ for (uint8_t i = 0; i < CFG_TUD_PRINTER; i++) {
+ printer_interface_t *p_printer = &_printer_itf[i];
+
+ tu_memclr(p_printer, sizeof(p_printer));
+ if (!_printer_fifo_cfg.rx_persistent) {
+ tu_fifo_clear(&p_printer->rx_ff);
+ }
+ if (!_printer_fifo_cfg.tx_persistent) {
+ tu_fifo_clear(&p_printer->tx_ff);
+ }
+ // tu_fifo_set_overwritable(&p_printer->rx_ff, true);
+ tu_fifo_set_overwritable(&p_printer->tx_ff, true);
+ }
+}
+
+uint16_t printerd_open(uint8_t rhport, const tusb_desc_interface_t *itf_desc, uint16_t max_len) {
+ TU_VERIFY(TUSB_CLASS_PRINTER == itf_desc->bInterfaceClass, 0);
+
+ // Identify available interface to open
+ printer_interface_t *p_printer;
+ uint8_t printer_id;
+ for (printer_id = 0; printer_id < CFG_TUD_PRINTER; printer_id++) {
+ p_printer = &_printer_itf[printer_id];
+ if (p_printer->ep_out == 0) {
+ break;
+ }
+ }
+ TU_ASSERT(printer_id < CFG_TUD_PRINTER);
+
+ //------------- Interface -------------//
+ uint16_t drv_len = sizeof(tusb_desc_interface_t);
+
+ //------------- Endpoints -------------//
+ TU_ASSERT(itf_desc->bNumEndpoints == 2);
+ drv_len += 2 * sizeof(tusb_desc_endpoint_t);
+ p_printer->itf_num = 2;
+ const uint8_t *p_desc = tu_desc_next(itf_desc);
+ TU_ASSERT(usbd_open_edpt_pair(rhport, p_desc, 2, TUSB_XFER_BULK, &p_printer->ep_out, &p_printer->ep_in), 0);
+
+ _prep_out_transaction(printer_id);
+
+ return drv_len;
+}
+
+bool printerd_control_xfer_cb(uint8_t rhport, uint8_t stage, const tusb_control_request_t *request) {
+ TU_VERIFY(request->bmRequestType_bit.recipient == TUSB_REQ_RCPT_INTERFACE);
+
+ if (request->bmRequestType_bit.type == TUSB_REQ_TYPE_STANDARD) {
+ //------------- STD Request -------------//
+ if (stage != CONTROL_STAGE_SETUP) {
+ return true;
+ }
+ } else if (request->bmRequestType_bit.type == TUSB_REQ_TYPE_CLASS) {
+ switch (request->bRequest) {
+ // https://www.usb.org/sites/default/files/usbprint11a021811.pdf
+ case PRINTER_REQ_CONTROL_GET_DEVICE_ID:
+ if (stage == CONTROL_STAGE_SETUP) {
+ const char deviceId[] = "MANUFACTURER:ACME Manufacturing;"
+ "MODEL:LaserBeam 9;"
+ "COMMAND SET:PS;"
+ "COMMENT:Anything you like;"
+ "ACTIVE COMMAND SET:PS;";
+ char buffer[256];
+ strcpy(buffer + 2, deviceId);
+ buffer[0] = 0x00;
+ buffer[1] = strlen(deviceId);
+ return tud_control_xfer(rhport, request, buffer, strlen(deviceId) + 2);
+ }
+ break;
+ case PRINTER_REQ_CONTROL_GET_PORT_STATUS:
+ if (stage == CONTROL_STAGE_SETUP) {
+ static uint8_t port_status = (0 << 3) | (1 << 1) | (1 << 2); // ~Paper empty + Selected + NoError
+ return tud_control_xfer(rhport, request, &port_status, sizeof(port_status));
+ }
+ break;
+ case PRINTER_REQ_CONTROL_SOFT_RESET:
+ if (stage == CONTROL_STAGE_SETUP) {
+ return false; // what to do ?
+ }
+ break;
+ default:
+ return false;
+ }
+ } else {
+ return false;
+ }
+ return true;
+}
+
+bool printerd_xfer_cb(uint8_t rhport, uint8_t ep_addr, xfer_result_t result, uint32_t xferred_bytes) {
+ uint8_t itf;
+ printer_interface_t *p_printer;
+
+ // Identify which interface to use
+ for (itf = 0; itf < CFG_TUD_PRINTER; itf++) {
+ p_printer = &_printer_itf[itf];
+ if (ep_addr == p_printer->ep_out) {
+ break;
+ }
+ }
+ TU_ASSERT(itf < CFG_TUD_PRINTER);
+ printer_epbuf_t *p_epbuf = &_printer_epbuf[itf];
+
+ // Received new data
+ if (ep_addr == p_printer->ep_out) {
+ tu_fifo_write_n(&p_printer->rx_ff, p_epbuf->epout, (uint16_t)xferred_bytes);
+ // invoke receive callback (if there is still data)
+ if (tud_printer_rx_cb && !tu_fifo_empty(&p_printer->rx_ff)) {
+ tud_printer_rx_cb(itf, xferred_bytes);
+ }
+ // prepare for OUT transaction
+ _prep_out_transaction(itf);
+ }
+
+ return true;
+}
+
+#endif
diff --git a/src/class/printer/printer_device.h b/src/class/printer/printer_device.h
new file mode 100644
index 000000000..8c21e39ce
--- /dev/null
+++ b/src/class/printer/printer_device.h
@@ -0,0 +1,79 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2026 Ha Thach (tinyusb.org)
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ *
+ * This file is part of the TinyUSB stack.
+ */
+
+#ifndef TUSB_PRINTER_DEVICE_H_
+#define TUSB_PRINTER_DEVICE_H_
+
+#include "printer.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+typedef struct TU_ATTR_PACKED {
+ uint8_t rx_persistent : 1; // keep rx fifo on bus reset or disconnect
+ uint8_t tx_persistent : 1; // keep tx fifo on bus reset or disconnect
+} tud_printer_configure_fifo_t;
+
+//--------------------------------------------------------------------+
+// Application API (Multiple Ports) i.e. CFG_TUD_PRINTER > 1
+//--------------------------------------------------------------------+
+
+// Get the number of bytes available for reading
+uint32_t tud_printer_n_available(uint8_t itf);
+
+// Read received bytes
+uint32_t tud_printer_n_read(uint8_t itf, void *buffer, uint32_t bufsize);
+
+// Clear the received FIFO
+void tud_printer_n_read_flush(uint8_t itf);
+
+// Get a byte from FIFO without removing it
+bool tud_printer_n_peek(uint8_t itf, uint8_t *ui8);
+
+//--------------------------------------------------------------------+
+// Application Callback API (weak is optional)
+//--------------------------------------------------------------------+
+
+// Invoked when received new data
+TU_ATTR_WEAK void tud_printer_rx_cb(uint8_t itf, size_t n);
+
+//--------------------------------------------------------------------+
+// Internal Class Driver API
+//--------------------------------------------------------------------+
+void printerd_init(void);
+bool printerd_deinit(void);
+void printerd_reset(uint8_t rhport);
+uint16_t printerd_open(uint8_t rhport, const tusb_desc_interface_t *itf_desc, uint16_t max_len);
+bool printerd_control_xfer_cb(uint8_t rhport, uint8_t stage, const tusb_control_request_t *request);
+bool printerd_xfer_cb(uint8_t rhport, uint8_t ep_addr, xfer_result_t event, uint32_t xferred_bytes);
+
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif
diff --git a/src/device/usbd.c b/src/device/usbd.c
index 1e21c667a..32b3a3ee2 100644
--- a/src/device/usbd.c
+++ b/src/device/usbd.c
@@ -334,6 +334,19 @@ static const usbd_class_driver_t _usbd_driver[] = {
.sof = NULL
},
#endif
+
+ #if CFG_TUD_PRINTER
+ {
+ .name = DRIVER_NAME("PRINTER"),
+ .init = printerd_init,
+ .deinit = printerd_deinit,
+ .reset = printerd_reset,
+ .open = printerd_open,
+ .control_xfer_cb = printerd_control_xfer_cb,
+ .xfer_cb = printerd_xfer_cb,
+ .sof = NULL
+ },
+ #endif
};
enum { BUILTIN_DRIVER_COUNT = TU_ARRAY_SIZE(_usbd_driver) };
diff --git a/src/device/usbd.h b/src/device/usbd.h
index bd5a3c395..3b296feea 100644
--- a/src/device/usbd.h
+++ b/src/device/usbd.h
@@ -313,6 +313,21 @@ bool tud_vendor_control_xfer_cb(uint8_t rhport, uint8_t stage, tusb_control_requ
//--------------------------------------------------------------------+
+// Printer Descriptor Templates
+//--------------------------------------------------------------------+
+
+#define TUD_PRINTER_DESC_LEN (9 + 7 + 7) // one interface, two endpoints
+
+#define TUD_PRINTER_DESCRIPTOR(_itfnum, _stridx, _epout, _epin, _epsize) \
+ /* Interface */\
+ 9, TUSB_DESC_INTERFACE, _itfnum, 0, 2, TUSB_CLASS_PRINTER, 1, 2, _stridx,\
+ /* Endpoint Out */\
+ 7, TUSB_DESC_ENDPOINT, _epout, TUSB_XFER_BULK, U16_TO_U8S_LE(_epsize), 0,\
+ /* Endpoint In */\
+ 7, TUSB_DESC_ENDPOINT, _epin, TUSB_XFER_BULK, U16_TO_U8S_LE(_epsize), 0
+
+
+//--------------------------------------------------------------------+
// HID Descriptor Templates
//--------------------------------------------------------------------+
diff --git a/src/tinyusb.mk b/src/tinyusb.mk
index 8f9d52de9..e7d1c0b5b 100644
--- a/src/tinyusb.mk
+++ b/src/tinyusb.mk
@@ -15,6 +15,7 @@ TINYUSB_SRC_C += \
src/class/mtp/mtp_device.c \
src/class/net/ecm_rndis_device.c \
src/class/net/ncm_device.c \
+ src/class/printer/printer_device.c \
src/class/usbtmc/usbtmc_device.c \
src/class/video/video_device.c \
src/class/vendor/vendor_device.c \
diff --git a/src/tusb.h b/src/tusb.h
index 62b3b9783..256a239e7 100644
--- a/src/tusb.h
+++ b/src/tusb.h
@@ -92,6 +92,10 @@
#include "class/mtp/mtp_device.h"
#endif
+ #if CFG_TUD_PRINTER
+ #include "class/printer/printer_device.h"
+ #endif
+
#if CFG_TUD_AUDIO
#include "class/audio/audio_device.h"
#endif
diff --git a/src/tusb_option.h b/src/tusb_option.h
index 64fe899db..80cbeab36 100644
--- a/src/tusb_option.h
+++ b/src/tusb_option.h
@@ -614,6 +614,10 @@
#define CFG_TUD_NCM 0
#endif
+#ifndef CFG_TUD_PRINTER
+ #define CFG_TUD_PRINTER 0
+#endif
+
#ifndef CFG_TUD_EDPT_DEDICATED_HWFIFO
#define CFG_TUD_EDPT_DEDICATED_HWFIFO 0
#endif