Updated stlink-v1 driver for macOS

- Updated xcode project settings v11.3.1 - Removed support for 10.6-10.12 - Compiled new kexts for macOS 10.13-10.15 - Moved instructions to separate README - Updated installation instructions
stlink-org · May 23, 2020 · edc5e44 · edc5e44
1 parent 937f4d6
commit edc5e44
Show file tree

Hide file tree

Showing 35 changed files with 3,403 additions and 108 deletions.
diff --git a/doc/tutorial.md b/doc/tutorial.md
@@ -29,70 +29,7 @@ Within the GUI main window tooltips explain the available user elements.
 
 
 ## Solutions to common problems
-### a) STLINK/v1 driver: Issue with Kernel Extension (kext) (macOS 10.11 and later only)
-#### Problem:
-
-st-util fails to detect a STLINK/v1 device:
-
-```
-st-util -1
-st-util $VERSION-STRING$
-WARN src/sg.c: Failed to find an stlink v1 by VID:PID
-ERROR src/sg.c: Could not open stlink device
-```
-
-#### Solution (clean setup):
-
-1) Configure System Integrity Protection (SIP)
-
-The root of this problem is a system security setting introduced by Apple with OS X El Capitan (10.11) in 2015.
-The so called System Integrity Protection (SIP) is active per default
-and prevents the operating system amongst other things to load unsigned Kernel Extension Modules (kext).
-Thus the STLINK/v1 driver supplied with the tools, which installs as a kext, remains not functional,
-while SIP is fully activated (as is per default).
-
-Action needs to be taken here by booting into the recovery mode where a terminal console window needs to be opened.
-
-For macOS 10.11 - 10.13 it is not recommended to disable SIP completely as with the command `csrutil disable`,
-because this leaves the system more vulnerable to common threats.
-Instead there is a more adequate and reasonable option implemented by Apple.
-Running `csrutil enable --without kext`, allows to load unsigned kernel extensions
-while leaving SIP active with all other security features.
-Unfortunately this option has been removed in macOS 10.14, which leaves the only option to disable SIP completely.
-
-So who ever intends to run the STLINK/v1 programmer on macOS please take this into account.
-
-Further details can be found here: https://forums.developer.apple.com/thread/17452
-
-2) Install the ST-Link-v1 driver from the subdirectory `/stlinkv1_macosx_driver`
-   by referring to the instructions in the README file available there.
-
-3) Move the $OS_VERSION$.kext file to `/System/Library/Extensions`.
-
-4) Load the Kernel Extension (kext): `$ sudo kextload -v /System/Library/Extensions/stlink_shield10_x.kext`
-
-```
-Requesting load of /System/Library/Extensions/stlink_shield10_x.kext.
-/System/Library/Extensions/stlink_shield10_x.kext loaded successfully (or already loaded).
-```
-
-5) Enter the command `$ sudo touch /System/Library/Extensions`
-
-
-7) Verify correct detection of the STLINK/v1 device with the following input: `st-util -1`
-
-You should then see a similar output like in this example:
-
-```
-INFO common.c: Loading device parameters....
-INFO common.c: Device connected is: F1 High-density device, id 0x10036414
-INFO common.c: SRAM size: 0x10000 bytes (64 KiB), Flash: 0x80000 bytes (512 KiB) in pages of 2048 bytes
-INFO sg.c: Successfully opened a stlink v1 debugger
-INFO gdb-server.c: Chip ID is 00000414, Core ID is  1ba01477.
-INFO gdb-server.c: Listening at *:4242...
-```
-
-### b) Verify if udev rules are set correctly (by Dave Hylands)
+### a) Verify if udev rules are set correctly (by Dave Hylands)
 
 To investigate, start by plugging your STLINK device into the usb port. Then run `lsusb`. You should see an entry something like the following:
 

diff --git a/stlinkv1_macos_driver/Makefile b/stlinkv1_macos_driver/Makefile
@@ -0,0 +1,57 @@
+# make ... for both stlink v1 and stlink v2 support
+##
+VPATH=src
+
+SOURCES_LIB=common.c usb.c sg.c logging.c
+OBJS_LIB=$(SOURCES_LIB:.c=.o)
+TEST_PROGRAMS=test-flash test-sg test-usb
+LDFLAGS=-L. -lstlink -lusb-1.0
+
+CFLAGS+=-g
+CFLAGS+=-DDEBUG=1
+CFLAGS+=-std=gnu11
+CFLAGS+=-Wall -Wextra
+
+
+LIBRARY=libstlink.a
+
+all:  $(LIBRARY) flash gdbserver $(TEST_PROGRAMS)
+
+$(LIBRARY): $(OBJS_LIB)
+	@echo "objs are $(OBJS_LIB)"
+	$(AR) -cr $@ $^
+	@echo "done making library"
+
+
+test_sg: test_sg.o $(LIBRARY)
+	@echo "building test_sg"
+	$(CC) test_sg.o $(LDFLAGS) -o $@
+
+test_usb: test_usb.o $(LIBRARY)
+	@echo "building test_usb"
+	$(CC) test_usb.o $(LDFLAGS) -o $@
+	@echo "done linking"
+
+%.o: %.c
+	@echo "building $^ into $@"
+	$(CC) $(CFLAGS) -c $^ -o $@
+	@echo "done compiling"
+
+clean:
+	rm -rf $(OBJS_LIB)
+	rm -rf $(LIBRARY)
+	rm -rf test_usb*
+	rm -rf test_sg*
+	$(MAKE) -C flash clean
+	$(MAKE) -C gdbserver clean
+
+flash:
+	$(MAKE) -C flash
+
+gdbserver:
+	$(MAKE) -C gdbserver CONFIG_USE_LIBSG="$(CONFIG_USE_LIBSG)"
+
+macos_stlink_shield:
+	./install.sh
+
+.PHONY: clean all flash gdbserver
diff --git a/stlinkv1_macos_driver/README.md b/stlinkv1_macos_driver/README.md
@@ -0,0 +1,42 @@
+from: [email protected]
+
+to: [email protected]
+
+Hi,
+
+I managed to get the stlink v1 working under os x and i would like to share the solution so maybe you can add it in your package. The problem is that os x claims the device as scsi and libusb won't be able to connect to it.
+I've created what is called a codeless driver which claims the device and has a higher priority then the default apple mass storage driver, so the device can be accessed through libusb. I tested this codeless driver under OS X 10.6.8 and 10.7.2.
+I assume it works with any 10.6.x and 10.7.x version as well. Attached to this mail you'll find the osx folder with the source code of the driver, both drivers (for 10.6.x and 10.7.x), an install.sh script and the modified Makefile, i only added a line at the end which invoke the `install.sh`.
+
+First, unpack the `osx.tar.gz` contents:
+```bash
+tar xzvf osx.tar.gz
+```
+
+Then, install the driver using:
+```bash
+sudo make osx_stlink_shield
+```
+
+no reboot required.
+
+P.S. If error `OS X version not supported` occurs. For the latest versions of Mac OS X you may need to change the `osx/install.sh` as follows:
+```bash
+< ISOSXLION=$(sw_vers -productVersion)
+---
+> ISOSXLION=$(sw_vers -productVersion | sed -e 's:.[[:digit:]]*$::')
+```
+
+### OS X 10.10 Yosemite
+
+For OS X 10.10 Yosemite you must force the system to load unsigned kernelextensions
+
+```bash
+sudo nvram boot-args="kext-dev-mode=1"
+```
+
+reboot the system!
+
+### OS X 10.11 El Capitan
+
+For OS X 10.11 El Capitan: the Yosemite kext seems to work (tested on 10.11.04).
diff --git a/stlinkv1_macos_driver/install.sh b/stlinkv1_macos_driver/install.sh
@@ -0,0 +1,22 @@
+#!/bin/bash
+
+ISMACOS=$(sw_vers -productVersion | sed -e 's:.[[:digit:]]*$::')
+case $ISMACOS in
+10.13)
+    KEXT="stlink_shield10_13.kext"
+    ;;
+10.14)
+    KEXT="stlink_shield10_14.kext"
+    ;;
+10.15)
+    KEXT="stlink_shield10_15.kext"
+    ;;
+*)
+    echo "OS X version not supported."
+    exit 1
+    ;;
+esac
+chown -R root:wheel $KEXT/
+cp -R $KEXT /System/Library/Extensions/stlink_shield.kext
+kextload -v /System/Library/Extensions/stlink_shield.kext
+touch /System/Library/Extensions
diff --git a/stlinkv1_macos_driver/stlink_shield_10.13.kext/Contents/Info.plist b/stlinkv1_macos_driver/stlink_shield_10.13.kext/Contents/Info.plist
@@ -0,0 +1,82 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>BuildMachineOSBuild</key>
+	<string>18G4032</string>
+	<key>CFBundleDevelopmentRegion</key>
+	<string>English</string>
+	<key>CFBundleIdentifier</key>
+	<string>com.libusb.stlink-shield</string>
+	<key>CFBundleInfoDictionaryVersion</key>
+	<string>6.0</string>
+	<key>CFBundlePackageType</key>
+	<string>KEXT</string>
+	<key>CFBundleSignature</key>
+	<string>????</string>
+	<key>CFBundleSupportedPlatforms</key>
+	<array>
+		<string>MacOSX</string>
+	</array>
+	<key>CFBundleVersion</key>
+	<string>1.0.0</string>
+	<key>DTCompiler</key>
+	<string>com.apple.compilers.llvm.clang.1_0</string>
+	<key>DTPlatformBuild</key>
+	<string>11C504</string>
+	<key>DTPlatformVersion</key>
+	<string>GM</string>
+	<key>DTSDKBuild</key>
+	<string>19B90</string>
+	<key>DTSDKName</key>
+	<string>macosx10.15</string>
+	<key>DTXcode</key>
+	<string>1130</string>
+	<key>DTXcodeBuild</key>
+	<string>11C504</string>
+	<key>IOKitPersonalities</key>
+	<dict>
+		<key>DeviceDriver</key>
+		<dict>
+			<key>CFBundleIdentifier</key>
+			<string>com.apple.kpi.iokit</string>
+			<key>IOClass</key>
+			<string>IOService</string>
+			<key>IOProviderClass</key>
+			<string>IOUSBDevice</string>
+			<key>bcdDevice</key>
+			<integer>256</integer>
+			<key>idProduct</key>
+			<integer>14148</integer>
+			<key>idVendor</key>
+			<integer>1155</integer>
+		</dict>
+		<key>InterfaceDriver</key>
+		<dict>
+			<key>CFBundleIdentifier</key>
+			<string>com.apple.kpi.iokit</string>
+			<key>IOClass</key>
+			<string>IOService</string>
+			<key>IOProviderClass</key>
+			<string>IOUSBInterface</string>
+			<key>bConfigurationValue</key>
+			<integer>1</integer>
+			<key>bInterfaceNumber</key>
+			<integer>0</integer>
+			<key>idProduct</key>
+			<integer>14148</integer>
+			<key>idVendor</key>
+			<integer>1155</integer>
+		</dict>
+	</dict>
+	<key>LSMinimumSystemVersion</key>
+	<string>10.13</string>
+	<key>OSBundleLibraries</key>
+	<dict>
+		<key>com.apple.iokit.IOUSBFamily</key>
+		<string>1.8</string>
+		<key>com.apple.kpi.libkern</key>
+		<string>11.2.0</string>
+	</dict>
+</dict>
+</plist>
diff --git a/stlinkv1_macos_driver/stlink_shield_10.13.kext/Contents/MacOS/stlink_shield_10.13 b/stlinkv1_macos_driver/stlink_shield_10.13.kext/Contents/MacOS/stlink_shield_10.13
diff --git a/stlinkv1_macos_driver/stlink_shield_10.13.kext/Contents/PkgInfo b/stlinkv1_macos_driver/stlink_shield_10.13.kext/Contents/PkgInfo
@@ -0,0 +1 @@
+KEXT????
diff --git a/stlinkv1_macos_driver/stlink_shield_10.13.kext/Contents/_CodeSignature/CodeResources b/stlinkv1_macos_driver/stlink_shield_10.13.kext/Contents/_CodeSignature/CodeResources
@@ -0,0 +1,115 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>files</key>
+	<dict/>
+	<key>files2</key>
+	<dict/>
+	<key>rules</key>
+	<dict>
+		<key>^Resources/</key>
+		<true/>
+		<key>^Resources/.*\.lproj/</key>
+		<dict>
+			<key>optional</key>
+			<true/>
+			<key>weight</key>
+			<real>1000</real>
+		</dict>
+		<key>^Resources/.*\.lproj/locversion.plist$</key>
+		<dict>
+			<key>omit</key>
+			<true/>
+			<key>weight</key>
+			<real>1100</real>
+		</dict>
+		<key>^Resources/Base\.lproj/</key>
+		<dict>
+			<key>weight</key>
+			<real>1010</real>
+		</dict>
+		<key>^version.plist$</key>
+		<true/>
+	</dict>
+	<key>rules2</key>
+	<dict>
+		<key>.*\.dSYM($|/)</key>
+		<dict>
+			<key>weight</key>
+			<real>11</real>
+		</dict>
+		<key>^(.*/)?\.DS_Store$</key>
+		<dict>
+			<key>omit</key>
+			<true/>
+			<key>weight</key>
+			<real>2000</real>
+		</dict>
+		<key>^(Frameworks|SharedFrameworks|PlugIns|Plug-ins|XPCServices|Helpers|MacOS|Library/(Automator|Spotlight|LoginItems))/</key>
+		<dict>
+			<key>nested</key>
+			<true/>
+			<key>weight</key>
+			<real>10</real>
+		</dict>
+		<key>^.*</key>
+		<true/>
+		<key>^Info\.plist$</key>
+		<dict>
+			<key>omit</key>
+			<true/>
+			<key>weight</key>
+			<real>20</real>
+		</dict>
+		<key>^PkgInfo$</key>
+		<dict>
+			<key>omit</key>
+			<true/>
+			<key>weight</key>
+			<real>20</real>
+		</dict>
+		<key>^Resources/</key>
+		<dict>
+			<key>weight</key>
+			<real>20</real>
+		</dict>
+		<key>^Resources/.*\.lproj/</key>
+		<dict>
+			<key>optional</key>
+			<true/>
+			<key>weight</key>
+			<real>1000</real>
+		</dict>
+		<key>^Resources/.*\.lproj/locversion.plist$</key>
+		<dict>
+			<key>omit</key>
+			<true/>
+			<key>weight</key>
+			<real>1100</real>
+		</dict>
+		<key>^Resources/Base\.lproj/</key>
+		<dict>
+			<key>weight</key>
+			<real>1010</real>
+		</dict>
+		<key>^[^/]+$</key>
+		<dict>
+			<key>nested</key>
+			<true/>
+			<key>weight</key>
+			<real>10</real>
+		</dict>
+		<key>^embedded\.provisionprofile$</key>
+		<dict>
+			<key>weight</key>
+			<real>20</real>
+		</dict>
+		<key>^version\.plist$</key>
+		<dict>
+			<key>weight</key>
+			<real>20</real>
+		</dict>
+	</dict>
+</dict>
+</plist>