mirror of
https://github.com/andreili/katapult.git
synced 2025-08-24 03:44:06 +02:00
c0014efc4a
Synchronize with the latest Klipper code. This pulls in the latest lib/ files (needed to use the pico-sdk v2.0.0 version). It updates to latest can2040 code (needed for pico-sdk v2.0.0 support). It implements USB double buffering (as is now done in Klipper). It adds in support for additional UART pins (as is now done in Klipper). It adds support for rp2350 chips. This replaces the execute in ram code previously implemented in Katapult with the execute in ram code that is now standard in Klipper. The CONFIG_RP2040_ADD_BOOT_SIGNATURE kconfig symbol was removed and the build now always produces a katapult.withclear.uf2 file. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
128 lines
3.9 KiB
C
128 lines
3.9 KiB
C
/**
|
|
* Copyright (c) 2024 Raspberry Pi (Trading) Ltd.
|
|
*
|
|
* SPDX-License-Identifier: BSD-3-Clause
|
|
*/
|
|
|
|
#ifndef _HARDWARE_STRUCTS_USB_DPRAM_H
|
|
#define _HARDWARE_STRUCTS_USB_DPRAM_H
|
|
|
|
#include "hardware/address_mapped.h"
|
|
#include "hardware/regs/usb.h"
|
|
|
|
// Reference to datasheet: https://datasheets.raspberrypi.com/rp2350/rp2350-datasheet.pdf#tab-registerlist_usb
|
|
//
|
|
// The _REG_ macro is intended to help make the register navigable in your IDE (for example, using the "Go to Definition" feature)
|
|
// _REG_(x) will link to the corresponding register in hardware/regs/usb.h.
|
|
//
|
|
// Bit-field descriptions are of the form:
|
|
// BITMASK [BITRANGE] FIELDNAME (RESETVALUE) DESCRIPTION
|
|
|
|
|
|
// 0-15
|
|
#define USB_NUM_ENDPOINTS 16
|
|
|
|
// allow user to restrict number of endpoints available to save RAN
|
|
#ifndef USB_MAX_ENDPOINTS
|
|
#define USB_MAX_ENDPOINTS USB_NUM_ENDPOINTS
|
|
#endif
|
|
|
|
// 1-15
|
|
#define USB_HOST_INTERRUPT_ENDPOINTS (USB_NUM_ENDPOINTS - 1)
|
|
|
|
// Endpoint buffer control bits
|
|
#define USB_BUF_CTRL_FULL 0x00008000u
|
|
#define USB_BUF_CTRL_LAST 0x00004000u
|
|
#define USB_BUF_CTRL_DATA0_PID 0x00000000u
|
|
#define USB_BUF_CTRL_DATA1_PID 0x00002000u
|
|
#define USB_BUF_CTRL_SEL 0x00001000u
|
|
#define USB_BUF_CTRL_STALL 0x00000800u
|
|
#define USB_BUF_CTRL_AVAIL 0x00000400u
|
|
#define USB_BUF_CTRL_LEN_MASK 0x000003FFu
|
|
#define USB_BUF_CTRL_LEN_LSB 0
|
|
|
|
// ep_inout_ctrl bits
|
|
#define EP_CTRL_ENABLE_BITS (1u << 31u)
|
|
#define EP_CTRL_DOUBLE_BUFFERED_BITS (1u << 30)
|
|
#define EP_CTRL_INTERRUPT_PER_BUFFER (1u << 29)
|
|
#define EP_CTRL_INTERRUPT_PER_DOUBLE_BUFFER (1u << 28)
|
|
#define EP_CTRL_INTERRUPT_ON_NAK (1u << 16)
|
|
#define EP_CTRL_INTERRUPT_ON_STALL (1u << 17)
|
|
#define EP_CTRL_BUFFER_TYPE_LSB 26u
|
|
#define EP_CTRL_HOST_INTERRUPT_INTERVAL_LSB 16u
|
|
|
|
#define USB_DPRAM_SIZE 4096u
|
|
|
|
// PICO_CONFIG: USB_DPRAM_MAX, Set amount of USB RAM used by USB system, min=0, max=4096, default=4096, group=hardware_usb
|
|
// Allow user to claim some of the USB RAM for themselves
|
|
#ifndef USB_DPRAM_MAX
|
|
#define USB_DPRAM_MAX USB_DPRAM_SIZE
|
|
#endif
|
|
|
|
// Define maximum packet sizes
|
|
#define USB_MAX_ISO_PACKET_SIZE 1023
|
|
#define USB_MAX_PACKET_SIZE 64
|
|
|
|
typedef struct {
|
|
// 4K of DPSRAM at beginning. Note this supports 8, 16, and 32 bit accesses
|
|
volatile uint8_t setup_packet[8]; // First 8 bytes are always for setup packets
|
|
|
|
// Starts at ep1
|
|
struct usb_device_dpram_ep_ctrl {
|
|
io_rw_32 in;
|
|
io_rw_32 out;
|
|
} ep_ctrl[USB_NUM_ENDPOINTS - 1];
|
|
|
|
// Starts at ep0
|
|
struct usb_device_dpram_ep_buf_ctrl {
|
|
io_rw_32 in;
|
|
io_rw_32 out;
|
|
} ep_buf_ctrl[USB_NUM_ENDPOINTS];
|
|
|
|
// EP0 buffers are fixed. Assumes single buffered mode for EP0
|
|
uint8_t ep0_buf_a[0x40];
|
|
uint8_t ep0_buf_b[0x40];
|
|
|
|
// Rest of DPRAM can be carved up as needed
|
|
uint8_t epx_data[USB_DPRAM_MAX - 0x180];
|
|
} usb_device_dpram_t;
|
|
|
|
static_assert(sizeof(usb_device_dpram_t) == USB_DPRAM_MAX, "");
|
|
static_assert(offsetof(usb_device_dpram_t, epx_data) == 0x180, "");
|
|
|
|
typedef struct {
|
|
// 4K of DPSRAM at beginning. Note this supports 8, 16, and 32 bit accesses
|
|
volatile uint8_t setup_packet[8]; // First 8 bytes are always for setup packets
|
|
|
|
// Interrupt endpoint control 1 -> 15
|
|
struct usb_host_dpram_ep_ctrl {
|
|
io_rw_32 ctrl;
|
|
io_rw_32 spare;
|
|
} int_ep_ctrl[USB_HOST_INTERRUPT_ENDPOINTS];
|
|
|
|
io_rw_32 epx_buf_ctrl;
|
|
io_rw_32 _spare0;
|
|
|
|
// Interrupt endpoint buffer control
|
|
struct usb_host_dpram_ep_buf_ctrl {
|
|
io_rw_32 ctrl;
|
|
io_rw_32 spare;
|
|
} int_ep_buffer_ctrl[USB_HOST_INTERRUPT_ENDPOINTS];
|
|
|
|
io_rw_32 epx_ctrl;
|
|
|
|
uint8_t _spare1[124];
|
|
|
|
// Should start at 0x180
|
|
uint8_t epx_data[USB_DPRAM_MAX - 0x180];
|
|
} usb_host_dpram_t;
|
|
|
|
static_assert(sizeof(usb_host_dpram_t) == USB_DPRAM_MAX, "");
|
|
static_assert(offsetof(usb_host_dpram_t, epx_data) == 0x180, "");
|
|
|
|
#define usb_dpram ((usb_device_dpram_t *)USBCTRL_DPRAM_BASE)
|
|
#define usbh_dpram ((usb_host_dpram_t *)USBCTRL_DPRAM_BASE)
|
|
|
|
static_assert( USB_HOST_INTERRUPT_ENDPOINTS == 15, "");
|
|
|
|
#endif // _HARDWARE_STRUCTS_USB_DPRAM_H
|