Added usbhs example.

This commit is contained in:
yellows8 2018-11-30 20:21:19 -05:00
parent 70e1e46a82
commit 4c836fd796
3 changed files with 379 additions and 0 deletions

View File

@ -1,3 +1,5 @@
# usb # usb
See libnx usb_comms.h. If you want to use usbds directly, see libnx usb_comms.c source and usb.h/usbds.h. See libnx usb_comms.h. If you want to use usbds directly, see libnx usb_comms.c source and usb.h/usbds.h.
For using USB devices, see the usbhs example.

193
usb/usbhs/Makefile Normal file
View File

@ -0,0 +1,193 @@
#---------------------------------------------------------------------------------
.SUFFIXES:
#---------------------------------------------------------------------------------
ifeq ($(strip $(DEVKITPRO)),)
$(error "Please set DEVKITPRO in your environment. export DEVKITPRO=<path to>/devkitpro")
endif
TOPDIR ?= $(CURDIR)
include $(DEVKITPRO)/libnx/switch_rules
#---------------------------------------------------------------------------------
# TARGET is the name of the output
# BUILD is the directory where object files & intermediate files will be placed
# SOURCES is a list of directories containing source code
# DATA is a list of directories containing data files
# INCLUDES is a list of directories containing header files
# EXEFS_SRC is the optional input directory containing data copied into exefs, if anything this normally should only contain "main.npdm".
# ROMFS is the directory containing data to be added to RomFS, relative to the Makefile (Optional)
#
# NO_ICON: if set to anything, do not use icon.
# NO_NACP: if set to anything, no .nacp file is generated.
# APP_TITLE is the name of the app stored in the .nacp file (Optional)
# APP_AUTHOR is the author of the app stored in the .nacp file (Optional)
# APP_VERSION is the version of the app stored in the .nacp file (Optional)
# APP_TITLEID is the titleID of the app stored in the .nacp file (Optional)
# ICON is the filename of the icon (.jpg), relative to the project folder.
# If not set, it attempts to use one of the following (in this order):
# - <Project name>.jpg
# - icon.jpg
# - <libnx folder>/default_icon.jpg
#---------------------------------------------------------------------------------
TARGET := $(notdir $(CURDIR))
BUILD := build
SOURCES := source
DATA := data
INCLUDES := include
EXEFS_SRC := exefs_src
#ROMFS := romfs
#---------------------------------------------------------------------------------
# options for code generation
#---------------------------------------------------------------------------------
ARCH := -march=armv8-a -mtune=cortex-a57 -mtp=soft -fPIE
CFLAGS := -g -Wall -O2 -ffunction-sections \
$(ARCH) $(DEFINES)
CFLAGS += $(INCLUDE) -D__SWITCH__
CXXFLAGS := $(CFLAGS) -fno-rtti -fno-exceptions
ASFLAGS := -g $(ARCH)
LDFLAGS = -specs=$(DEVKITPRO)/libnx/switch.specs -g $(ARCH) -Wl,-Map,$(notdir $*.map)
LIBS := -lnx
#---------------------------------------------------------------------------------
# list of directories containing libraries, this must be the top level containing
# include and lib
#---------------------------------------------------------------------------------
LIBDIRS := $(PORTLIBS) $(LIBNX)
#---------------------------------------------------------------------------------
# no real need to edit anything past this point unless you need to add additional
# rules for different file extensions
#---------------------------------------------------------------------------------
ifneq ($(BUILD),$(notdir $(CURDIR)))
#---------------------------------------------------------------------------------
export OUTPUT := $(CURDIR)/$(TARGET)
export TOPDIR := $(CURDIR)
export VPATH := $(foreach dir,$(SOURCES),$(CURDIR)/$(dir)) \
$(foreach dir,$(DATA),$(CURDIR)/$(dir))
export DEPSDIR := $(CURDIR)/$(BUILD)
CFILES := $(foreach dir,$(SOURCES),$(notdir $(wildcard $(dir)/*.c)))
CPPFILES := $(foreach dir,$(SOURCES),$(notdir $(wildcard $(dir)/*.cpp)))
SFILES := $(foreach dir,$(SOURCES),$(notdir $(wildcard $(dir)/*.s)))
BINFILES := $(foreach dir,$(DATA),$(notdir $(wildcard $(dir)/*.*)))
#---------------------------------------------------------------------------------
# use CXX for linking C++ projects, CC for standard C
#---------------------------------------------------------------------------------
ifeq ($(strip $(CPPFILES)),)
#---------------------------------------------------------------------------------
export LD := $(CC)
#---------------------------------------------------------------------------------
else
#---------------------------------------------------------------------------------
export LD := $(CXX)
#---------------------------------------------------------------------------------
endif
#---------------------------------------------------------------------------------
export OFILES_BIN := $(addsuffix .o,$(BINFILES))
export OFILES_SRC := $(CPPFILES:.cpp=.o) $(CFILES:.c=.o) $(SFILES:.s=.o)
export OFILES := $(OFILES_BIN) $(OFILES_SRC)
export HFILES_BIN := $(addsuffix .h,$(subst .,_,$(BINFILES)))
export INCLUDE := $(foreach dir,$(INCLUDES),-I$(CURDIR)/$(dir)) \
$(foreach dir,$(LIBDIRS),-I$(dir)/include) \
-I$(CURDIR)/$(BUILD)
export LIBPATHS := $(foreach dir,$(LIBDIRS),-L$(dir)/lib)
export BUILD_EXEFS_SRC := $(TOPDIR)/$(EXEFS_SRC)
ifeq ($(strip $(ICON)),)
icons := $(wildcard *.jpg)
ifneq (,$(findstring $(TARGET).jpg,$(icons)))
export APP_ICON := $(TOPDIR)/$(TARGET).jpg
else
ifneq (,$(findstring icon.jpg,$(icons)))
export APP_ICON := $(TOPDIR)/icon.jpg
endif
endif
else
export APP_ICON := $(TOPDIR)/$(ICON)
endif
ifeq ($(strip $(NO_ICON)),)
export NROFLAGS += --icon=$(APP_ICON)
endif
ifeq ($(strip $(NO_NACP)),)
export NROFLAGS += --nacp=$(CURDIR)/$(TARGET).nacp
endif
ifneq ($(APP_TITLEID),)
export NACPFLAGS += --titleid=$(APP_TITLEID)
endif
ifneq ($(ROMFS),)
export NROFLAGS += --romfsdir=$(CURDIR)/$(ROMFS)
endif
.PHONY: $(BUILD) clean all
#---------------------------------------------------------------------------------
all: $(BUILD)
$(BUILD):
@[ -d $@ ] || mkdir -p $@
@$(MAKE) --no-print-directory -C $(BUILD) -f $(CURDIR)/Makefile
#---------------------------------------------------------------------------------
clean:
@echo clean ...
@rm -fr $(BUILD) $(TARGET).pfs0 $(TARGET).nso $(TARGET).nro $(TARGET).nacp $(TARGET).elf
#---------------------------------------------------------------------------------
else
.PHONY: all
DEPENDS := $(OFILES:.o=.d)
#---------------------------------------------------------------------------------
# main targets
#---------------------------------------------------------------------------------
all : $(OUTPUT).pfs0 $(OUTPUT).nro
$(OUTPUT).pfs0 : $(OUTPUT).nso
$(OUTPUT).nso : $(OUTPUT).elf
ifeq ($(strip $(NO_NACP)),)
$(OUTPUT).nro : $(OUTPUT).elf $(OUTPUT).nacp
else
$(OUTPUT).nro : $(OUTPUT).elf
endif
$(OUTPUT).elf : $(OFILES)
$(OFILES_SRC) : $(HFILES_BIN)
#---------------------------------------------------------------------------------
# you need a rule like this for each extension you use as binary data
#---------------------------------------------------------------------------------
%.bin.o %_bin.h : %.bin
#---------------------------------------------------------------------------------
@echo $(notdir $<)
@$(bin2o)
-include $(DEPENDS)
#---------------------------------------------------------------------------------------
endif
#---------------------------------------------------------------------------------------

184
usb/usbhs/source/main.c Normal file
View File

@ -0,0 +1,184 @@
// Include the most common headers from the C standard library
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <malloc.h>
// Include the main libnx system header, for Switch development
#include <switch.h>
// This example shows how to use USB devices via usbhs, see also libnx usbhs.h/usb.h.
// Only devices which are not used by sysmodules are usable, hence HID devices are not usable with this for example.
// Main program entrypoint
int main(int argc, char* argv[])
{
Result rc=0;
s32 total_entries=0;
s32 i, epi, tmpi;
Event inf_event;
struct usb_endpoint_descriptor *ep_desc = NULL;
UsbHsClientIfSession inf_session;//This example only uses 1 interface/endpoint, an actual app may use multiple.
UsbHsClientEpSession ep_session;
UsbHsInterfaceFilter filter;
UsbHsInterface interfaces[8];
// This example uses a text console, as a simple way to output text to the screen.
// If you want to write a software-rendered graphics application,
// take a look at the graphics/simplegfx example, which uses the libnx gfx API instead.
// If on the other hand you want to write an OpenGL based application,
// take a look at the graphics/opengl set of examples, which uses EGL instead.
consoleInit(NULL);
printf("usbhs example\n");
memset(&inf_event, 0, sizeof(inf_event));
memset(&filter, 0, sizeof(filter));
memset(interfaces, 0, sizeof(interfaces));
memset(&inf_session, 0, sizeof(inf_session));
memset(&ep_session, 0, sizeof(ep_session));
//Leave filter at all-zero to disable filtering. If you want to use filtering, see libnx usbhs.h.
rc = usbHsInitialize();
if (R_FAILED(rc)) printf("usbHsInitialize() failed: 0x%x\n", rc);
if (R_SUCCEEDED(rc)) {
rc = usbHsCreateInterfaceAvailableEvent(&inf_event, true, 0, &filter);
if (R_FAILED(rc)) printf("usbHsCreateInterfaceAvailableEvent() failed: 0x%x\n", rc);
}
if (R_SUCCEEDED(rc)) printf("Ready.\n");
// Main loop
while (appletMainLoop())
{
// Scan all the inputs. This should be done once for each frame
hidScanInput();
// hidKeysDown returns information about which buttons have been
// just pressed in this frame compared to the previous one
u64 kDown = hidKeysDown(CONTROLLER_P1_AUTO);
if (kDown & KEY_PLUS)
break; // break in order to return to hbmenu
rc = eventWait(&inf_event, 0);
if (R_SUCCEEDED(rc)) {
printf("The available interfaces have changed.\n");
memset(interfaces, 0, sizeof(interfaces));
rc = usbHsQueryAvailableInterfaces(&filter, interfaces, sizeof(interfaces), &total_entries);
if (R_FAILED(rc)) printf("usbHsQueryAvailableInterfaces() failed: 0x%x\n", rc);
if (R_SUCCEEDED(rc)) {
printf("total: %d\n", total_entries);
for(i=0; i<total_entries; i++) {
printf("%d: pathstr = %s\n", i, interfaces[i].pathstr);//Run any interfaces[i] processing here.
// You can verify whether this is an interface you want to use by checking the content of interfaces[i], or do so later via control transfers etc.
rc = usbHsAcquireUsbIf(&inf_session, &interfaces[i]);
printf("usbHsAcquireUsbIf(interface index = %d) returned: 0x%x\n", i, rc);
if (R_SUCCEEDED(rc)) {
u8* tmpbuf = memalign(0x1000, 0x1000);// The allocated buffer address/size must be 0x1000-byte aligned, for usbHsIfCtrlXfer/usbHsEpPostBuffer.
if (tmpbuf) {
u32 transferredSize=0;
// Note that an actual app may want to validate that transferredSize==<input size>.
// This shows how to use a control transfer, an actual app might not need this.
// This gets descriptors starting with the config descriptor, via a control transfer.
memset(tmpbuf, 0, 0x1000);
rc = usbHsIfCtrlXfer(&inf_session, USB_ENDPOINT_IN, USB_REQUEST_GET_DESCRIPTOR, (USB_DT_CONFIG<<8) | 0, 0, 0x40, tmpbuf, &transferredSize);
printf("usbHsIfCtrlXfer(interface index = %d) returned: 0x%x, transferredSize=0x%x\n", i, rc, transferredSize);
if (R_SUCCEEDED(rc)) {
for(tmpi=0; tmpi<transferredSize; tmpi++)printf("%02X", tmpbuf[tmpi]);
printf("\n");
}
rc = 1;
// Locate any endpoints you want to use by going through input_endpoint_descs/output_endpoint_descs.
for(epi=0; epi<15; epi++) {
ep_desc = &inf_session.inf.inf.input_endpoint_descs[epi];
if(ep_desc->bLength != 0) {
printf("Using endpoint %d.\n", epi);
rc = usbHsIfOpenUsbEp(&inf_session, &ep_session, 1, ep_desc->wMaxPacketSize, ep_desc);
printf("usbHsIfOpenUsbEp returned: 0x%x\n", rc);
break;
}
}
// Since this example uses just any device, this may not work for some devices since this doesn't use a proper protocol. Some devices might need unplugged and plugged back in for this to work, after running this example once.
if (R_SUCCEEDED(rc)) {
memset(tmpbuf, 0, 0x1000);
transferredSize = 0;
rc = usbHsEpPostBuffer(&ep_session, tmpbuf, 0x10, &transferredSize);
printf("usbHsEpPostBuffer returned: 0x%x, transferredSize=0x%x\n", rc, transferredSize);
if (R_SUCCEEDED(rc)) {
for(tmpi=0; tmpi<transferredSize; tmpi++)printf("%02X", tmpbuf[tmpi]);
printf("\n");
}
usbHsEpClose(&ep_session);//At this point this example is done using the endpoint, close it.
}
free(tmpbuf);
}
else
printf("tmpbuf alloc failed.\n");
usbHsIfClose(&inf_session);//At this point this example is done using the interface, close it.
}
}
}
}
// Signaled when a device was removed, cleanup state if our interface can't be found in the usbHsQueryAcquiredInterfaces output.
rc = eventWait(usbHsGetInterfaceStateChangeEvent(), 0);
if (R_SUCCEEDED(rc)) {
eventClear(usbHsGetInterfaceStateChangeEvent());
printf("InterfaceStateChangeEvent was signaled.\n");
// Only need to check the rest of this if our interface is actually initialized. This won't actually run since this example already closed the interface above.
if (usbHsIfIsActive(&inf_session)) {
memset(interfaces, 0, sizeof(interfaces));
rc = usbHsQueryAcquiredInterfaces(interfaces, sizeof(interfaces), &total_entries);
if (R_FAILED(rc)) printf("usbHsQueryAcquiredInterfaces() failed: 0x%x\n", rc);
if (R_SUCCEEDED(rc)) {
bool found_flag = 0;
for(i=0; i<total_entries; i++) {
if (usbHsIfGetID(&inf_session) == interfaces[i].inf.ID) {
found_flag = 1;
break;
}
}
if(!found_flag) {
printf("Interface not found, cleaning up state...\n");
usbHsEpClose(&ep_session);
usbHsIfClose(&inf_session);
}
}
}
}
// Update the console, sending a new frame to the display
consoleUpdate(NULL);
}
// Make sure to cleanup interface/endpoint state before exiting, if it's not already closed.
usbHsDestroyInterfaceAvailableEvent(&inf_event, 0);
usbHsExit();
// Deinitialize and clean up resources used by the console (important!)
consoleExit(NULL);
return 0;
}