/* * geany_encoding=koi8-r * usb_lib.h * * Copyright 2018 Edward V. Emelianov * * 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 2 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., 51 Franklin Street, Fifth Floor, Boston, * MA 02110-1301, USA. * */ #pragma once #ifndef __USB_LIB_H__ #define __USB_LIB_H__ #include #include "usb_defs.h" // Max EP amount (EP0 + other used) #define MAX_ENDPOINTS 4 // bRequest, standard; for bmRequestType == 0x80 #define GET_STATUS 0x00 #define GET_DESCRIPTOR 0x06 #define GET_CONFIGURATION 0x08 // for bmRequestType == 0 #define CLEAR_FEATURE 0x01 #define SET_FEATURE 0x03 // unused #define SET_ADDRESS 0x05 #define SET_DESCRIPTOR 0x07 // unused #define SET_CONFIGURATION 0x09 // for bmRequestType == 0x81, 1 or 0xB2 #define GET_INTERFACE 0x0A // unused #define SET_INTERFACE 0x0B // unused #define SYNC_FRAME 0x0C // unused // vendor requests #define VENDOR_MASK_REQUEST 0x40 #define VENDOR_READ_REQUEST_TYPE 0xc0 #define VENDOR_WRITE_REQUEST_TYPE 0x40 #define VENDOR_REQUEST 0x01 #define CONTROL_REQUEST_TYPE 0x21 // Class-Specific Control Requests #define SEND_ENCAPSULATED_COMMAND 0x00 #define GET_ENCAPSULATED_RESPONSE 0x01 #define SET_COMM_FEATURE 0x02 #define GET_COMM_FEATURE 0x03 #define CLEAR_COMM_FEATURE 0x04 #define SET_LINE_CODING 0x20 #define GET_LINE_CODING 0x21 #define SET_CONTROL_LINE_STATE 0x22 #define SEND_BREAK 0x23 // control line states #define CONTROL_DTR 0x01 #define CONTROL_RTS 0x02 // wValue #define DEVICE_DESCRIPTOR 0x100 #define CONFIGURATION_DESCRIPTOR 0x200 #define STRING_LANG_DESCRIPTOR 0x300 #define STRING_MAN_DESCRIPTOR 0x301 #define STRING_PROD_DESCRIPTOR 0x302 #define STRING_SN_DESCRIPTOR 0x303 #define DEVICE_QALIFIER_DESCRIPTOR 0x600 // EPnR bits manipulation #define CLEAR_DTOG_RX(R) (R & USB_EPnR_DTOG_RX) ? R : (R & (~USB_EPnR_DTOG_RX)) #define SET_DTOG_RX(R) (R & USB_EPnR_DTOG_RX) ? (R & (~USB_EPnR_DTOG_RX)) : R #define TOGGLE_DTOG_RX(R) (R | USB_EPnR_DTOG_RX) #define KEEP_DTOG_RX(R) (R & (~USB_EPnR_DTOG_RX)) #define CLEAR_DTOG_TX(R) (R & USB_EPnR_DTOG_TX) ? R : (R & (~USB_EPnR_DTOG_TX)) #define SET_DTOG_TX(R) (R & USB_EPnR_DTOG_TX) ? (R & (~USB_EPnR_DTOG_TX)) : R #define TOGGLE_DTOG_TX(R) (R | USB_EPnR_DTOG_TX) #define KEEP_DTOG_TX(R) (R & (~USB_EPnR_DTOG_TX)) #define SET_VALID_RX(R) ((R & USB_EPnR_STAT_RX) ^ USB_EPnR_STAT_RX) | (R & (~USB_EPnR_STAT_RX)) #define SET_NAK_RX(R) ((R & USB_EPnR_STAT_RX) ^ USB_EPnR_STAT_RX_1) | (R & (~USB_EPnR_STAT_RX)) #define SET_STALL_RX(R) ((R & USB_EPnR_STAT_RX) ^ USB_EPnR_STAT_RX_0) | (R & (~USB_EPnR_STAT_RX)) #define KEEP_STAT_RX(R) (R & (~USB_EPnR_STAT_RX)) #define SET_VALID_TX(R) ((R & USB_EPnR_STAT_TX) ^ USB_EPnR_STAT_TX) | (R & (~USB_EPnR_STAT_TX)) #define SET_NAK_TX(R) ((R & USB_EPnR_STAT_TX) ^ USB_EPnR_STAT_TX_1) | (R & (~USB_EPnR_STAT_TX)) #define SET_STALL_TX(R) ((R & USB_EPnR_STAT_TX) ^ USB_EPnR_STAT_TX_0) | (R & (~USB_EPnR_STAT_TX)) #define KEEP_STAT_TX(R) (R & (~USB_EPnR_STAT_TX)) #define CLEAR_CTR_RX(R) (R & (~USB_EPnR_CTR_RX)) #define CLEAR_CTR_TX(R) (R & (~USB_EPnR_CTR_TX)) #define CLEAR_CTR_RX_TX(R) (R & (~(USB_EPnR_CTR_TX | USB_EPnR_CTR_RX))) // USB state: uninitialized, addressed, ready for use #define USB_DEFAULT_STATE 0 #define USB_ADRESSED_STATE 1 #define USB_CONFIGURE_STATE 2 // EP types #define EP_TYPE_BULK 0x00 #define EP_TYPE_CONTROL 0x01 #define EP_TYPE_ISO 0x02 #define EP_TYPE_INTERRUPT 0x03 #define _USB_STRING_(name, str) \ const struct name \ { \ uint8_t bLength; \ uint8_t bDescriptorType; \ wchar_t bString[(sizeof(str) - 2) / 2]; \ \ } \ name = {sizeof(name), 0x03, str}; // EP0 configuration packet typedef struct { uint8_t bmRequestType; uint8_t bRequest; uint16_t wValue; uint16_t wIndex; uint16_t wLength; } config_pack_t; // endpoints state typedef struct __ep_t{ uint16_t *tx_buf; uint8_t *rx_buf; uint16_t (*func)(); uint16_t status; unsigned rx_cnt : 10; unsigned tx_flag : 1; unsigned rx_flag : 1; unsigned setup_flag : 1; } ep_t; // USB status & its address typedef struct { uint8_t USB_Status; uint16_t USB_Addr; }usb_dev_t; typedef struct { uint32_t dwDTERate; uint8_t bCharFormat; #define USB_CDC_1_STOP_BITS 0 #define USB_CDC_1_5_STOP_BITS 1 #define USB_CDC_2_STOP_BITS 2 uint8_t bParityType; #define USB_CDC_NO_PARITY 0 #define USB_CDC_ODD_PARITY 1 #define USB_CDC_EVEN_PARITY 2 #define USB_CDC_MARK_PARITY 3 #define USB_CDC_SPACE_PARITY 4 uint8_t bDataBits; } __attribute__ ((packed)) usb_LineCoding; typedef struct { uint8_t bmRequestType; uint8_t bNotificationType; uint16_t wValue; uint16_t wIndex; uint16_t wLength; } __attribute__ ((packed)) usb_cdc_notification; extern uint8_t setlinecoding; #define SETLINECODING() (setlinecoding) #define CLRLINECODING() do{setlinecoding = 0;}while(0) void USB_Init(); uint8_t USB_GetState(); void EP_Init(uint8_t number, uint8_t type, uint16_t addr_tx, uint16_t addr_rx, uint16_t (*func)(ep_t ep)); void EP_WriteIRQ(uint8_t number, const uint8_t *buf, uint16_t size); void EP_Write(uint8_t number, const uint8_t *buf, uint16_t size); int EP_Read(uint8_t number, uint8_t *buf); usb_LineCoding getLineCoding(); void WEAK linecoding_handler(usb_LineCoding *lc); void WEAK clstate_handler(uint16_t val); void WEAK break_handler(); void WEAK vendor_handler(config_pack_t *packet); #endif // __USB_LIB_H__