ra8_usb_pprn.h

Go to the documentation of this file.

 
#pragma once
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
 
#include "ra8_err.h"
#include "ra8_usb.h"
 
/* =============================================================================
 * Constants
 * =============================================================================
 */

typedef enum : uint8_t {
  k_ra8_pprn_pipe_bulk_out = 3U, 
  k_ra8_pprn_pipe_bulk_in  = 4U, 
} ra8_usb_pprn_pipe_t;

typedef enum : uint8_t {
  k_ra8_pprn_ep_bulk_out_addr = 1U, 
  k_ra8_pprn_ep_bulk_in_addr  = 2U, 
} ra8_usb_pprn_ep_t;

typedef enum : uint16_t {
  k_ra8_pprn_bulk_max_packet_fs = 64U,  
  k_ra8_pprn_bulk_max_packet_hs = 512U, 
} ra8_usb_pprn_packet_t;

typedef enum : uint8_t {
  k_ra8_pprn_class_printer    = 0x07U, 
  k_ra8_pprn_subclass_default = 0x01U, 
  k_ra8_pprn_protocol_unidir  = 0x01U, 
  k_ra8_pprn_protocol_bidir   = 0x02U, 
  k_ra8_pprn_protocol_1284_4  = 0x03U, 
} ra8_usb_pprn_class_t;

typedef enum : uint8_t {
  k_ra8_pprn_req_get_device_id   = 0x00U, 
  k_ra8_pprn_req_get_port_status = 0x01U, 
  k_ra8_pprn_req_soft_reset      = 0x02U, 
} ra8_usb_pprn_request_t;

typedef enum : uint8_t {
  k_ra8_pprn_status_bit_paper_empty = 5U, 
  k_ra8_pprn_status_bit_select      = 4U, 
  k_ra8_pprn_status_bit_not_error   = 3U, 
} ra8_usb_pprn_port_status_bit_t;

typedef ra8_err_t (*ra8_usb_pprn_setup_fn_t)(void* ctx, const ra8_usb_setup_t* setup);
 
/* =============================================================================
 * Lifecycle
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_usb_pprn_init(ra8_usb_speed_t speed);

[[nodiscard]] ra8_err_t ra8_usb_pprn_close(void);
 
/* =============================================================================
 * Descriptor + identity handoff
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_usb_pprn_set_descriptors(const uint8_t* desc,
                                                     uint16_t       desc_len,
                                                     const uint8_t* device_id,
                                                     uint16_t       device_id_len);
 
/* =============================================================================
 * Print data transport
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_usb_pprn_recv(uint8_t* buf, uint16_t max_len, uint16_t* got_len);

[[nodiscard]] ra8_err_t ra8_usb_pprn_send(const uint8_t* data, uint16_t len);
 
/* =============================================================================
 * Port-status shadow
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_usb_pprn_set_port_status(uint8_t status_byte);

[[nodiscard]] ra8_err_t ra8_usb_pprn_get_port_status(uint8_t* out_status);
 
/* =============================================================================
 * Setup-handler attach
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_usb_pprn_attach_setup_handler(ra8_usb_pprn_setup_fn_t setup_fn,
                                                          void*                   ctx);
 
/* =============================================================================
 * Class SETUP dispatch
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_usb_pprn_handle_setup(const ra8_usb_setup_t* setup);
 
#ifdef __cplusplus
}
#endif