Jeonghun (James) Lee: 11월 2020

11/22/2020

USB OTG (Gadget Config FS) 사용법

1. USB Gadget Config FS 사용법

USB Gadget Config File System은 기존의 Legacy Gadget 처럼 Kernel Module 만 올리면 되는 것이 아니라,

USB Gadget Config File System을 Mount를 한 후 User에서 필요한 USB Device에 관해서 Descriptor 정보 와 Function을 연결하는 방식이다.

물론 Composite Device도 지원가능하며, 이를 위해서 Multi Function 기능사용해야한다.

Python기반의 USB Gadget 관리

https://pypi.org/project/gadgetconfig/

1.1 USB Kernel 설정 후 빌드 및 확인

USB OTG 사용시 Gadget 관련 Kernel 설정 및 확인

USB Gadget에 관련된 Kernel 설정은 아래의 링크로 확인하고 관련 기능 확인
https://ahyuo79.blogspot.com/2020/11/usb-device-gadget-cdc.html

USB Gadget Kernel API

Gadget의 세부적인 구현을 하려면 반드시 알아야함

https://www.kernel.org/doc/html/v4.13/driver-api/usb/gadget.html

USB Host Debugging

https://elinux.org/images/1/17/USB_Debugging_and_Profiling_Techniques.pdf

https://ahyuo79.blogspot.com/2014/11/usb-host-gadget-debug-2.html

1.2 USB Device 와 USB Function 구조 파악

기존의 USB Legacy 와 크게 다르지 않으므로, 중략

USB Legacy Gadget 사용법

https://ahyuo79.blogspot.com/2020/11/usb-otg-gadget-legacy.html

USB Gadget Config FS 의 구조 와 Functions 구조

Configuration Descriptor
Interface Descriptor -> Function (USB Device) ==> Class Driver (USB Host 와 연결)

included Endpoint Descriptors

https://training.ti.com/sites/default/files/docs/USB-M6-USB-in-Device-Mode.pdf

USB Gadget Config File system mount 후 아래와 같이 설정

https://training.ti.com/sites/default/files/docs/USB-M6-USB-in-Device-Mode.pdf

2. USB Gadget Config FS 사용법

상위 그림처럼 Kernel Config에서 설정 후 /sys/kernel/config/usb_gadget 을 mount 후 직접 USB Device 설정 및

USB Function 부분 연결가능하며, 동작도 역시 Legacy USB Gadget 가 거의 동일하게 동작한다.

2.1 USB Serial (g_serial 과 동일)

설정방법만 소개하고 테스트 방법 및 사용법은 기존 Legacy와 크게 다르지 않다

USB Serial (ACM) 예제

상위 g_serial 과 동일하게 동작하며, 테스트 방법도 동일

# Check Kernel Config about Gadget and ConfigFS 
$ mount -t configfs none /sys/kernel/config
$ cd /sys/kernel/config/usb_gadget

# Create g1/g2/g3 Gadget(USB Device) STEP1
$ mkdir g1

# Set USB Device Descriptor STEP2
$ cd g1
$ ls
UDC              bMaxPacketSize0  functions        strings
bDeviceClass     bcdDevice        idProduct
bDeviceProtocol  bcdUSB           idVendor
bDeviceSubClass  configs          os_desc

$ echo "0x1d6b" > idVendor
$ echo "0x0104" > idProduct

# Create/Set USB Device Descriptor about String STEP2
$ mkdir strings/0x409
$ ls strings/0x409/
manufacturer  product       serialnumber

$ echo "0123456789" > strings/0x409/serialnumber
$ echo "Foo Inc." > strings/0x409/manufacturer
$ echo "Bar Gadget" > strings/0x409/product


# Create/Set USB Config Descriptor STEP3 
$ mkdir configs/c.1
$ ls configs/c.1
MaxPower      bmAttributes  strings

# Set USB Config Descriptor for String STEP3 
$ mkdir configs/c.1/strings/0x409
$ ls configs/c.1/strings/0x409/
configuration

# Set USB Config Descriptor for String STEP4 
$ echo "CDC ACM" > configs/c.1/strings/0x409/configuration

# Create USB Interface Descriptor (Functions)  STEP5,6 
# USB Host              /dev/ttyACMx
# USB Device (Gadget)   /dev/ttymxc4  (need g_serial)   CONFIG_USB_G_SERIAL  
$ mkdir functions/acm.GS0

# Link USB Interface Descriptor (Functions)  STEP5,6 
$ ln -s functions/acm.GS0 configs/c.1

# Check USB Gadget 의 UDC name 파악 
# i.MX의 경우 현재 USB OTG 설정은 다음과 같이 Device Tree에서 설정 
#  ci_hdrc.0 : Device  
#  ci_hdrc.1:  Host    
# TI는 musb-hdrc.0/1로 사용 
# 각 AP마다 이름이 다르며, Device Tree의 설정같이 봐야함 (아래의 UDC에 정의하면 동작함) 
$ ls /sys/class/udc/
ci_hdrc.0

# Activate USB-CDC ACM Device 동작  (Host에서 ACM, USB Serial 확인가능) 
$ echo "ci_hdrc.0" > UDC

$ find /sys -name *hdrc*  //OTG1 (ci_hdrc.0) , OTG2 (ci_hdrc.1) 검색 
/sys/kernel/debug/ci_hdrc.1
/sys/kernel/debug/ci_hdrc.0
/sys/devices/soc0/soc/2100000.aips-bus/2184200.usb/ci_hdrc.1
/sys/devices/soc0/soc/2100000.aips-bus/2184000.usb/ci_hdrc.0
/sys/devices/soc0/soc/2100000.aips-bus/2184000.usb/ci_hdrc.0/udc/ci_hdrc.0
/sys/class/udc/ci_hdrc.0
/sys/bus/platform/devices/ci_hdrc.0
/sys/bus/platform/devices/ci_hdrc.1
/sys/bus/platform/drivers/ci_hdrc
/sys/bus/platform/drivers/ci_hdrc/ci_hdrc.0
/sys/bus/platform/drivers/ci_hdrc/ci_hdrc.1

$ cat /sys/bus/platform/devices/ci_hdrc.0/uevent
DRIVER=ci_hdrc
MODALIAS=platform:ci_hdrc

$ cat /sys/bus/platform/devices/ci_hdrc.1/uevent
DRIVER=ci_hdrc
MODALIAS=platform:ci_hdrc

https://elixir.bootlin.com/linux/v4.9/ident/ci_hdrc

UVC Gadget 설정방법
  https://developer.ridgerun.com/wiki/index.php?title=How_to_use_the_UVC_gadget_driver_in_Linux

Gadget Config FS 관련설정참고
  https://www.kernel.org/doc/Documentation/usb/gadget_configfs.txt
  https://www.kernel.org/doc/Documentation/usb/gadget-testing.txt
  https://www.kernel.org/doc/Documentation/filesystems/configfs/configfs.txt

2.2 다른 설정 (상위와 거의 동일함)

상위구조처럼 생성한 후 Function 이름만 아래와 같이 변경해서 사용하면된다.

Name	Driver	Description	Documentation
acm	Abstract Control Model (CDC ACM)	ACM serial link, works with Windows/Linux (use Documentation/usb/linux-cdc-acm.inf)	Documentation/usb/gadget_serial.txt
gser	Generic serial bulk in/out	The function talks to the Linux-USB generic serial driver
obex	Object Exchange Model (CDC OBEX)	Needs an user space OBEX server
rndis	RNDIS	Microsoft "Remote NDIS" (RNDIS) Ethernet protocol (use Documentation/usb/linux.inf)
ecm	Ethernet Control Model (CDC ECM)	Ethernet Control Model
eem	Ethernet Emulation Model (EEM)	Newer USB Ethernet standard that is somewhat simpler than CDC ECM
ncm	Network Control Model (CDC NCM)	Advanced protocol for Ethernet
ffs	Function filesystem (FunctionFS)	Allows to implement USB functions from user-space (e.g. for MTP)	Documentation/usb/functionfs.txt
mass_storage	Mass storage	Exports a regular file or block device as USB Mass Storage disk drive	Documentation/usb/mass-storage.txt
hid	HID function	Generic emulation of USB Human Interface Devices (HID)	Documentation/usb/gadget_hid.txt

USB Gadget Config FS 예제 및 Function 부분 자세히 설명

https://developer.toradex.com/knowledge-base/usb-device-mode-linux

USB Gadget Config FS Composite 예제
  https://elinux.org/images/e/ef/USB_Gadget_Configfs_API_0.pdf

USB Gadget Config FS 예제 및 검증
  https://www.ti.com/lit/an/spracb5/spracb5.pdf
  https://xilinx-wiki.atlassian.net/wiki/spaces/A/pages/18841729/Zynq+Ultrascale+MPSOC+Linux+USB+device+driver

2.3 Gadget Config FS 와 libusg 사용

상위 설정을 Shell Script가 아닌 C로 작성하여 사용방법

http://libusbg.github.io/index.html
http://libusbg.github.io/gadget-acm-ecm_8c-example.html

2.4 Android Gadget Config FS 예제

Android USB Config FS
https://stackoverflow.com/questions/48419908/how-to-setup-usb-gadget-via-configfs-in-android-shell

https://developer.toradex.com/knowledge-base/usb-device-mode-linux

https://osmocom.org/projects/quectel-modems/wiki/Android_USB_Gadget

https://dark2pee.tistory.com/entry/Android-%EB%B6%80%ED%8C%85%EC%8B%9C-USB-Device-Gadget-%EC%84%A4%EC%A0%95

Android USB Config FS 관련초기설정

https://android.googlesource.com/platform/system/core/+/refs/tags/android-8.1.0_r65/rootdir/init.usb.rc

https://android.googlesource.com/platform/system/core/+/refs/tags/android-8.1.0_r65/rootdir/init.usb.configfs.rc

Android udev 처럼 uevent 관리

https://android.googlesource.com/platform/system/core/+/refs/tags/android-8.1.0_r65/rootdir/ueventd.rc

3. Window RNDIS 관련문제사항

추후 필요없는 부분 삭제

RNDIS(Remote NDIS)관련설명

  https://docs.microsoft.com/en-us/windows-hardware/drivers/network/remote-ndis--rndis-2

Window에서 RNDIS 의 인식문제
  https://answers.microsoft.com/en-us/windows/forum/windows_10-networking-winpc/windows-10-vs-remote-ndis-ethernet-usbgadget-not/cb30520a-753c-4219-b908-ad3d45590447

RNDIS Driver Download (해결되지 않음)
  http://www.catalog.update.microsoft.com/ScopedViewRedirect.aspx?updateid=37e35bd4-d788-4b83-9416-f78e439f90a2
  https://www.driverscape.com/download/usb-ethernet-rndis-gadget

RNDIS Gadget Window Driver (RNDIS Driver가 아님)
  https://driversupdatecenters.com/drivers/?driver=USB+Ethernet%2FRNDIS+Gadget+Driver&p=28

11/18/2020

USB OTG (Gadget) Legacy 사용법

1. USB Legacy Gadget 사용법

Kernel에서 기존부터 제공하는 Legacy Gadget 으로 Kernel의 Gadget Module Driver를 Load를 하면 쉽게 사용하는 방법이다.

Legacy를 사용하기 위해서는 각 Kernel Legacy Gadget Driver들을 반드시 Module로 만들어서 사용해야한다.

1.1 USB Kernel 설정 후 빌드 및 확인

USB OTG 사용시 Gadget 관련 Kernel 설정 및 확인

USB Gadget에 관련된 Kernel 설정은 아래의 링크로 확인하고 관련 기능 확인
https://ahyuo79.blogspot.com/2020/11/usb-device-gadget-cdc.html

USB Gadget Kernel API

Gadget의 세부적인 구현을 하려면 반드시 알아야함

https://www.kernel.org/doc/html/v4.13/driver-api/usb/gadget.html

USB Host Debugging

https://elinux.org/images/1/17/USB_Debugging_and_Profiling_Techniques.pdf

https://ahyuo79.blogspot.com/2014/11/usb-host-gadget-debug-2.html

1.2 USB Device 와 USB Function 구조 파악

내부적으로 보면 , Legacy Gadget Driver 역시 Kernel 의 USB Function을 사용하므로 관련소스를 보면 이해하기가 쉽다

USB Device Descriptor 구조

Configuration Descriptor
Interface Descriptor -> Function (USB Device) ==> Class Driver (USB Host 와 연결)

included Endpoint Descriptors

Gadget Legacy Driver 역시 내부적으로 각 Function 들과 연결되어 동작되어짐

https://training.ti.com/sites/default/files/docs/USB-M6-USB-in-Device-Mode.pdf

2. USB Legacy Gadget Module 사용

기본적인 사용법은 각 사용할 Module 찾아 Module을 올리면 기본적으로 동작된다.

다만 확인해야 할 사항이 현재 UDC가 사용가능하는 것을 확인해야하고, 더불어 UDC가 사용중이면, 사용 중인 Module Driver를 제거를 한 후 다른 Module를 사용해야한다.

두 개의 기능을 동시에 사용하고 싶다면 Composite Device 을 Kernel에서 설정을 해야하며, 제한적으로 사용가능하다.

에러사항

보통 gadget을 사용중이거나, kernel에서 udc를 별도로 설정을 안했을 경우

$ modprobe g_serial
udc-core: couldn't find an available UDC - added [g_serial] to list of pending drivers

$ lsmod   // 현재 사용중인 다른 gadget 확인 or USB Gadget ConfigFS에서 설정한 것 해제

USB CDC 의 관련사항
https://en.wikipedia.org/wiki/Ethernet_over_USB

USB Legacy Gadget의 공통 Parameter 및 설정방법

Parameter	Purpose	Type
idVendor	USB Vendor ID	(ushort)
idProduct	USB Product ID	(ushort)
bcdDevice	USB Device version	(BCD) (ushort)
iSerialNumber	SerialNumber string	(charp)
iManufacturer	USB Manufacturer string	(charp)
iProduct	Product string	(charp)

$ vi /etc/modprobe.d/options  // modprobe usbserial vendor=0x0525 product=0xA4A6
....
options usbserial vendor=0x0525 product=0xA4A6
...

https://processors.wiki.ti.com/index.php/Linux_USB_Gadget_Parameter_Customization

http://www.armadeus.org/wiki/index.php?title=USB_Gadget

반드시 필독 (아래 이외의 UVC 와 UVA g_printer 사용)

TI-USB와 다른 AP와 별차이가 없으며 쉽게 설명

https://training.ti.com/sites/default/files/docs/USB-M6-USB-in-Device-Mode.pdf

USB 모든 Gadget 기본 TET 방법

USB Device Gadget Function기준으로 테스트 방법

https://www.kernel.org/doc/Documentation/usb/gadget-testing.txt

2.1 g_serial (ACM)

USB to Serial 가장 많이 사용이 되며, 동작역시 쉽게된다.

USB Device 설정

# CONFIG_USB_G_SERIAL 
# USB Gadget Driver (Device의 /dev/ttyGS0 -> Host의 ACM) 실제연결
$ modprobe g_serial
g_serial gadget: Gadget Serial v2.4
g_serial gadget: g_serial ready
g_serial gadget: high-speed config #2: CDC ACM config

USB Device: ttyGS0 생성
USB Host: ttyACMx

USB Device 에서 USB Host 통신확인

Host에서 간단히 TEST Message 확인 및 socat으로 다른 /dev/ttyx 와 /dev/ttyGS0 연결

$ ls /dev/ttyGS0    // 생성확인 
/dev/ttyGS0
$ cat /sys/class/tty/ttyGS0/dev
246:0

// Host에서 USB Serial로 연결 후 Baudrate를 맘대로 변경해도 다 됨 (기본 115200) 설정 후 테스트  
$ echo "Test " > /dev/ttyGS0
$ cat /dev/ttyGS0

https://www.kernel.org/doc/Documentation/usb/gadget_serial.txt
https://linux-sunxi.org/USB_Gadget/Serial

2.2 g_ether (RNDIS/ECM)

Kernel 설정 및 USB Host 지원상황에 따라 USB CDC 가 달라지며, 각각 독립적인 Network이 구성되며, 각 Route Table 역시 확인해봐야한다.

USB Device 설정

$ modprobe g_ether
using random self ethernet address
using random host ethernet address
usb0: HOST MAC a2:3a:fa:76:8c:18
usb0: MAC 4a:1e:02:84:f1:3f
using random self ethernet address
using random host ethernet address
g_ether gadget: Ethernet Gadget, version: Memorial Day 2008
g_ether gadget: g_ether ready
g_ether gadget: high-speed config #2: RNDIS

or 

$ modprobe g_ether idVendor=0x1234 idProduct=0xabcd bcdDevice=0x0304 \
iSerialNumber=sn7890 iManufacturer=myCom iProduct=demo

USB Device Network 설정

아래와 같이 강제로 usb0을 up 시키거나, 자동으로 잡도록 /etc/network/interface or /etc/systemd/network/xxx.network 로 설정

$ ifconfig usb0 up
$ ifconfig usb0
usb0      Link encap:Ethernet  HWaddr 4A:1E:02:84:F1:3F
          inet6 addr: fe80::481e:2ff:fe84:f13f/64 Scope:Link
          UP BROADCAST RUNNING MULTICAST  MTU:1500  Metric:1
          RX packets:0 errors:0 dropped:0 overruns:0 frame:0
          TX packets:0 errors:0 dropped:0 overruns:0 carrier:0
          collisions:0 txqueuelen:1000
          RX bytes:0 (0.0 B)  TX bytes:0 (0.0 B)

$ ifconfig usb0 192.168.5.7

USB Host Network 설정

USB Host 의 경우 usb0으로 잡혀도 route table이 link-local로 잡혀 제대로 통신이 되지 않는다.

그러므로 별도로 route table를 설정해줘야 한다.

$ ifconfig usb0 192.168.5.11 

// Route Table에 현재 설정한 부분이 link-local로 되며, 등록이 안됨
$ route
...
link-local      0.0.0.0         255.255.0.0     U     204    0        0 usb0
..
// 직접 Route Table에 추가 
$ sudo route add -net 192.168.5.0 netmask 255.255.255.0 usb0
....
192.168.5.0     0.0.0.0         255.255.255.0   U     0      0        0 usb0

USB Device 와 Host 검증

최종테스트 Host 와 Device 사이에 ping으로 테스트 진행하며, ifconfig에서 Packet이 전송되었는지를 반드시 확인하자

$ ifconfig usb0        //USB Device 
usb0      Link encap:Ethernet  HWaddr 4A:1E:02:84:F1:3F
          inet addr:192.168.5.7  Bcast:192.168.5.255  Mask:255.255.255.0
          inet6 addr: fe80::b4fe:8fff:fe61:d00d/64 Scope:Link
          UP BROADCAST RUNNING MULTICAST  MTU:1500  Metric:1
          RX packets:0 errors:0 dropped:0 overruns:0 frame:0
          TX packets:0 errors:0 dropped:0 overruns:0 carrier:0
          collisions:0 txqueuelen:1000
          RX bytes:0 (0.0 B)  TX bytes:0 (0.0 B)

$ ifconfig usb0        //USB Host  
usb0      Link encap:Ethernet  HWaddr A2:3A:FA:76:8C:18
          inet addr:192.168.5.11  Bcast:192.168.5.255  Mask:255.255.255.0
          inet6 addr: fe80::b4fe:8fff:fe61:d00d/64 Scope:Link
          UP BROADCAST RUNNING MULTICAST  MTU:1500  Metric:1
          RX packets:0 errors:0 dropped:0 overruns:0 frame:0
          TX packets:0 errors:0 dropped:0 overruns:0 carrier:0
          collisions:0 txqueuelen:1000
          RX bytes:0 (0.0 B)  TX bytes:0 (0.0 B)

좀 더 속도 및 세부적으로 검증하고자 하면, iperf 를 이용하여 세부검증을 하자.

2.3 g_mass_storage (MASS STORAGE)

일반적으로 내부 Partition을 연결하거나 File을 연결하여 사용하면 된다.
내부 파일을 연결시에는 Image를 만들어서 연결해도 상관이 없지만, FAT로 Format 후 사용하자.

Window에서 인식하기 위해서 File or Device FAT or NTFS 로 format을 해야함

$ modprobe g_mass_storage file=/dev/mmcblk0p3   
Mass Storage Function, version: 2009/09/11
LUN: removable file: (no medium)
LUN: file: /dev/mmcblk0p3
Number of LUNs=1
g_mass_storage gadget: Mass Storage Gadget, version: 2009/09/11
g_mass_storage gadget: userspace failed to provide iSerialNumber
g_mass_storage gadget: g_mass_storage ready
g_mass_storage gadget: high-speed config #1: Linux File-Backed Storage

11/15/2020

USB OTG (Gadget) 이해 및 설정

1. USB Gadget 기능 및 기본이해

오래전 부터 USB 2.0 부터 OTG가 많이지원이 되면서 Host 와 Peripheral Mode로 동시에 사용가능하도록 지원가능 했다. (정확히 하면, USB 2.0 전에 나옴)

그리고, Linux Kernel에서는 USB의 Peripheral , 즉 USB Device Mode를 지원하기 위해서 USB Gadget이라는 이름으로 Driver를 제공을 하고 이를 지원을 해서 사용했지만,

매번 사용만 하고 크게 정리하지 않아 이번 기회에 정리를 하고자 한다.

USB Host 와 Gadget 기본
https://ahyuo79.blogspot.com/2014/11/usb-driver.html

USB Device Descriptor 기본구조 이해
https://ahyuo79.blogspot.com/2014/10/usb-device-descriptor.html

USB Interface Descriptor 와 USB Class driver 연결
https://ahyuo79.blogspot.com/2014/11/class-descriptor.html

1.1 USB OTG의 기능

USB OTG는 USB 2.0에서나온 기술로 On-The-Go 약어로 Host 와 Device를 동시에 사용할 수 있는 기술이다.

이 기술내에는 몇가지 지원되는 Protocol이 있으며, 관련 Protocol은 Wiki에서 찾아볼 수 있다.

USB Peripherals

기본적인 USB Device로 VBUS 5V로 들어온 것을 Regulator로 3.3V 변경

https://www.maximintegrated.com/en/design/technical-documents/tutorials/1/1822.html

USB OTG Tranceiver

상위 USB Device와 다르게 두가지 역할(Host or Device) 를 위해 구성 추가되어진다.

Host or Deivce에 따라 변경가능한 Pull-up/down Tranciever 저항 (D+/D-)
아래 A-DEVICE(Host)처럼 Vbus 5V를 모니터할 기능 (HNP 참고, C-DETECT)
아래 B-DEVICE(Device)처럼 Vbus Pulse 가능과 모니터 가능 (SNP 참고, SRP[B] )
5번째 Pin인 ID Input Pin이 아래의 ASIC에서 Output로 변경가능

https://www.maximintegrated.com/en/design/technical-documents/tutorials/1/1822.html

USB Host가 되는 법

15K pulldown resitors on D+/D- 와 Power 공급
Send SOF(Start of Frame) Packets
Send SETUP,IN, and OUT Packets
Schedule transfers within USB 1ms frames
Signal USB reset
Provide USB power management

추가적으로 OTG에서는 Host 와 Device의 두개의 역할을 하므로, 회로적으로 별도의 Protocol들이 지원해야하는데, HNP 와 SNP 이다. (5Pin이 지원되는 Cable 사용)

Host Negotiation Protocol (HNP)

OTG dual-role device는 Host 혹은 Device로 동작이 가능하며 초기에 A-DEVICE는 Host , B-DEVICE는 Device로 동작하는 것이라면,

USB가 연결되는 즉시, OTG의 각각의 Role은 변경될 수 있다. 5번째 ID Pin을 Host에서 GND로 연결하면, 이를 Host로 동작한다.

OTG가 Host or Device로 결정되려고 하면 반드시 필수

https://www.maximintegrated.com/en/design/technical-documents/tutorials/1/1822.html

Session Request Protocol (SRP)

HNP 다음으로, B-DEVICE(Device)는 A-DEVICE(HOST)에게 Vbus power를 요청한 USB Host 와 Device의 Session이 시작되어지며,

기본조건은 상위 HNP가 동작한 후 Host가 Vbus Power 결정된 후 사용되어진다고 하며, Power Consumption에서 중요하다고 한다.

https://www.maximintegrated.com/en/design/technical-documents/tutorials/1/1822.html

Attach Detection Protocol (ADP)

재미있는 기능같은데, OTG Host or Device가 USB power가 없는 상태에서 붙는 것을 결정한다고 하는데, 상위 HNP 구조와 다르게 동작할 것으로 생각된다.

또다른 Device 붙었는지 알기 위해서 주기적으로 USB의 Capacitance를 측정한다고 하며, 큰 값이 측정되며, A-Device(Host)로 Power 공급을 한다고 하며,

그 이후에는 상위와 같이 SRP를 사용한다고 한다.

  https://en.wikipedia.org/wiki/USB_On-The-Go
  https://www.maximintegrated.com/en/design/technical-documents/tutorials/1/1822.html
  http://vaultmicro.blogspot.com/2014/06/usb-otg-usb.html

USB 의 관련전체

https://en.wikipedia.org/wiki/USB

1.2 USB Host 와 Device 기본동작구조

USB Host 와 Device 기본동작구조이지만, libusb 사용했을 경우 이며, 만약 USB Host에 Kernel Driver 존재하면 VFS를 걸치지 않고 바로 Control

https://elinux.org/images/1/17/USB_Debugging_and_Profiling_Techniques.pdf

libusb 구조

VFS(Virtual Filesystem)을 이용하지만, device filesystem으로 접근하여 연결함

https://ahyuo79.blogspot.com/2015/01/usb-libusb.html

1.3 USB Gadget에 관련 File System

아래의 USB Gadget File system은 전부 Kernel에서 기본으로 지원동작가능하며, 지원되는 File system의 발전된 부분을 알아야 한다.

GadgetFS

2003년에 Gadget FS로 처음 도입되었으며, 기본적으로 User space에서 동작하는 Gadget driver를 구현가능하도록

Kernel 의 Interface로 이를 지원하며 User space에서 App기반으로 USB Gadget과 USB Host 부분을 구현가능하다.

아래의 그림과 같이 Gadget FS 와 User Space 연결되어 동작되므로 Kernel의 Linux header 와 Gadget Filesystem mount 가 필요하다.

https://elinux.org/images/e/ef/USB_Gadget_Configfs_API_0.pdf

GadgetFS 를 이용한 User App 사용시 Kernel Header 사용

User space에서는 Gadget File system mount가 된 상태에서 동작가능

// User App에서 Gadget Filesystem Mount 필요
$ mkdir /dev/gadget
$ mount -t gadgetfs gadgetfs /dev/gadget

// User App에서  Device 의 경우 Kernel의 Header 필요
#include <linux/types.h>
#include <linux/usb/ch9.h>
#include <linux/usb/gadgetfs.h>

//User App에서 Host 의 경우 Kernel의 Header 필요 
#include <linux/usbdevice_fs.h>
#include <linux/usb/ch9.h>

https://blog.soutade.fr/post/2016/07/create-your-own-usb-gadget-with-gadgetfs.html

https://www.kernel.org/doc/html/v4.13/driver-api/usb/gadget.html

상위 기능은 요즘 거의 사용되지 않는 것으로 보인다. 쉽게 작성하려면 역시 libusb를 사용

FunctionFS

2010년에 도입이 되었으며, Kernel 에서 Gadget Function 들을 제공하고 있으며, 이 기능은 USB Device의 기본동작가능하며,

이를 기반으로 Composite USB Device도 작성도 가능하다.

또한 여기서 끝나지 않고 Kernel의 Gadget Function 과 User Space Gadget Function 조합도 가능하다고 하지만, 뭔가가 부족하다고 하니

지속적으로 사용해봐야 알겠다.

USB Gadget ConfigFS

가장 나중에 도입된 기능으로, User space에서 Config FS를 이용하여 USB Device의 Descriptor를 정의 및 설정 과 수정가능하며,

내부적으로 FunctionFS의 기능을 쉽게 설정으로 연결하여 사용가능할 뿐 더러 더불어 Composite USB Driver도 생성가능 하다

https://elinux.org/images/e/ef/USB_Gadget_Configfs_API_0.pdf

2. Uboot / Linux Kernel 의 OTG 관련 설정

Linux or Uboot에서 OTG 관련설정을 이해하도록 하며, 보통 Device Tree 부터 이해를 해야한다.

Linux or Uboot 둘 다 요즘 동일한 Device Tree를 사용하기 때문에 , 설정을 이해하고 관련 Kernel Config를 알아 두자.

Uboot Source로 Gadget 역시 Kernel 구조와 비슷하게 변경중

https://gitlab.denx.de/u-boot/u-boot/-/blob/master/drivers/usb/gadget/Kconfig

https://gitlab.denx.de/u-boot/u-boot/-/tree/master/drivers/usb

https://gitlab.denx.de/u-boot/u-boot

Uboot 의 Sandbox 지원 및 Sandbox 관련내용

https://wiki.amarulasolutions.com/uboot/sandbox.html

https://coral.googlesource.com/uboot-imx/+/refs/heads/alpha/test/py/

https://chromium.googlesource.com/chromium/src/+/master/docs/design/sandbox.md

https://www.digitalocean.com/community/tutorials/how-to-sandbox-processes-with-systemd-on-ubuntu-20-04

UBoot Custodians

https://www.denx.de/wiki/U-Boot/Custodians

Uboot Manual

https://www.denx.de/wiki/DULG/Manual

2.1 USB OTG 의 Device Tree 설정

일반적으로 USB OTG를 사용할 경우 Device or Host가 동시에 동작이 되지만, 대부분 안정성을 위해서 하나로 설정하여 사용하기도 한다.

Device Tree 문법설명

https://www.devicetree.org/specifications/

https://developer.toradex.com/device-tree-customization

https://jung-max.github.io/2019/10/22/Device_Tree_%EB%AC%B8%EB%B2%95/

https://ahyuo79.blogspot.com/2018/04/raspberry-pi-device-tree-cmdline.html

https://ahyuo79.blogspot.com/2015/08/kernel-boot-kernel-device-tree.html

아래의 설정은 USB의 레귤레이터 과 Pin 선언 설정부분이며, 즉 전원관련부분이다,

OTG를 Host를 사용할 경우, 전원공급을 해줘야 하며, Peripheral (Device)로 사용할 경우 전원이 불필요하므로, 이를 GPIO로 On/off를 제어

$ vi kernel-source/arch/arm/boot/dts/imx6sx-sdb.dtsi
......

regulators {
                compatible = "simple-bus";
                #address-cells = <1>;
                #size-cells = <0>;
                
                reg_usb_otg1_vbus: regulator-usb-otg1-vbus {
                        compatible = "regulator-fixed";
                        pinctrl-names = "default";
                        pinctrl-0 = <&pinctrl_usb_otg1>;
                        regulator-name = "usb_otg1_vbus";
                        regulator-min-microvolt = <5000000>;
                        regulator-max-microvolt = <5000000>;
                        gpio = <&gpio1 9 GPIO_ACTIVE_HIGH>;
                        enable-active-high;
                };

                reg_usb_otg2_vbus: regulator-usb-otg2-vbus {
                        compatible = "regulator-fixed";
                        pinctrl-names = "default";
                        pinctrl-0 = <&pinctrl_usb_otg2>;
                        regulator-name = "usb_otg2_vbus";
                        regulator-min-microvolt = <5000000>;
                        regulator-max-microvolt = <5000000>;
                        gpio = <&gpio1 12 GPIO_ACTIVE_HIGH>;
                        enable-active-high;
                };
         ....
/*
- enable-active-high	: Polarity of "enable-gpio" GPIO is active HIGH.
			  Default is active LOW.
  https://www.kernel.org/doc/Documentation/devicetree/bindings/regulator/gpio-regulator.txt         
*/
       }

실제 OTG의 동작모드를 설정하며, 각 OTG의 Protocol 옵션 사용여부 설정한다. 더불어 Phy Chip의 저항역시 설정.

$ vi kernel-source/arch/arm/boot/dts/imx6sx-sdb.dtsi
....
/*
   USB OTG1 Peripheral Mode 가 아닌 OTG Mode (Dual Mode)          
 - dr_mode: tells Dual-Role USB controllers that we want to work on a particular mode. 
            Valid arguments are "host", "peripheral" and "otg". In case this attribute isn't
			passed via DT, USB DRD controllers should default to OTG.   
            
    아래와 같이 srp/hnp/adp는 peripheral에서 사용하는 기능이며, OTG로 사용시 disable 함 
    
 - hnp-disable: tells OTG controllers we want to disable OTG HNP,
                       normally HNP is the basic function of real OTG except you want it to be a srp-capable only B device.
 - srp-disable: tells OTG controllers we want to disable OTG SRP, SRP is	optional for OTG device.
 - adp-disable: tells OTG controllers we want to disable OTG ADP, ADP is	optional for OTG device.
            
   https://www.kernel.org/doc/Documentation/devicetree/bindings/usb/generic.txt 
*/

&usbotg1 {
        vbus-supply = <&reg_usb_otg1_vbus>;
        pinctrl-names = "default";
        pinctrl-0 = <&pinctrl_usb_otg1_id>;
        srp-disable;
        hnp-disable;
        adp-disable;
        status = "okay";
};

/*
   USB OTG2 Host Mode (Dual Mode)
   dr_mode  Host Only 로만 변경 
*/
&usbotg2 {
        vbus-supply = <&reg_usb_otg2_vbus>;
        dr_mode = "host";
        status = "okay";
};

/*
 USB Phy 1, 2 
- fsl,tx-cal-45-dn-ohms: Integer [30-55]. Resistance (in ohms) of switchable
  high-speed trimming resistor connected in parallel with the 45 ohm resistor
  that terminates the DN output signal. Default: 45
- fsl,tx-cal-45-dp-ohms: Integer [30-55]. Resistance (in ohms) of switchable
  high-speed trimming resistor connected in parallel with the 45 ohm resistor
  that terminates the DP output signal. Default: 45
- fsl,tx-d-cal: Integer [79-119]. Current trimming value (as a percentage) of the 17.78mA TX reference current. Default: 100
  https://www.kernel.org/doc/Documentation/devicetree/bindings/phy/mxs-usb-phy.txt 
*/
&usbphy1 {
        fsl,tx-d-cal = <106>;
};

&usbphy2 {
        fsl,tx-d-cal = <106>;
};

2.2 Linux Kernel Gadget 설정

Linux Kernel에서 Host는 많이 봐왔기 때문에 관련부분은 생략하고 , USB Device Mode로 동작될 때 사용되는 Gadget의 구조를 파악하자.

Linux Kernel Gadget 기본구조

아래의 구조의 이해는 User Interface에서 사용할때, 관련동작이 이해하기사

kernel/drivers/usb/gadget/
kernel/drivers/usb/gadget/function/
kernel/drivers/usb/gadget/legacy/
kernel/drivers/usb/gadget/udc/

TI USB Gadget 구조 참조
https://e2e.ti.com/support/processors/f/791/t/825474

** Kernel Config FS 설정확인 후 USB Config 설정가능

  > File systems > Pseudo filesystems  Gadget Support
 [*] /proc file system support
 [*]   Sysctl support (/proc/sys)
 [*]   Enable /proc page monitoring 
 [ ] Include /proc/<pid>/task/<tid>/children file 
 -*- sysfs file system support  
 [*] Tmpfs virtual memory file system support (former shm fs) 
 [ ]   Tmpfs POSIX Access Control Lists
 [ ]   Tmpfs extended attributes
 -*- Userspace-driven configuration filesystem                       #CONFIG_CONFIGFS_FS

** Kernel USB Gadget / Legacy / Function Config

 Device Drivers > USB support > USB Gadget Support
 [ ]   Debugging messages (DEVELOPMENT)                                   #CONFIG_USB_GADGET_DEBUG                               
 [ ]   Debugging information files (DEVELOPMENT)                          #CONFIG_USB_GADGET_DEBUG_FILES                           
 [ ]   Debugging information files in debugfs (DEVELOPMENT)               #CONFIG_USB_GADGET_DEBUG_FS  
 (2)   Maximum VBUS Power usage (2-500 mA)                                #CONFIG_USB_GADGET_VBUS_DRAW 
 (2)   Number of storage pipeline buffers                                 #CONFIG_USB_GADGET_STORAGE_NUM_BUFFERS   
 [ ]   Serial gadget console support                                      #CONFIG_U_SERIAL_CONSOLE 
       USB Peripheral Controller  --->       // 별도서브메뉴로,  아래참조 drivers/usb/gadget/udc/Kconfig                    
 <*>   USB Gadget functions configurable through configfs         #CONFIG_USB_CONFIGFS , USB Gadget ConfigFS 
 [*]     Generic serial bulk in/out                                       #CONFIG_USB_CONFIGFS_SERIAL , CONFIG_USB_CONFIGFS_xx선택   
 [*]     Abstract Control Model (CDC ACM)                                 #CONFIG_USB_CONFIGFS_ACM   
 [*]     Object Exchange Model (CDC OBEX)                                 #CONFIG_USB_CONFIGFS_OBEX  
 [*]     Network Control Model (CDC NCM)                                  #CONFIG_USB_CONFIGFS_NCM   
 [*]     Ethernet Control Model (CDC ECM)                                 #CONFIG_USB_CONFIGFS_ECM  
 [*]     Ethernet Control Model (CDC ECM) subset                          #CONFIG_USB_CONFIGFS_ECM_SUBSET 
 [*]     RNDIS                                                            #CONFIG_USB_CONFIGFS_RNDIS  
 [*]     Ethernet Emulation Model (EEM)                                   #CONFIG_USB_CONFIGFS_EEM  
 [*]     Mass storage                                                     #CONFIG_USB_CONFIGFS_MASS_STORAGE  
 [*] UTP over Storage Gadget                                                 
 [*]     Loopback and sourcesink function (for testing)                   #CONFIG_USB_CONFIGFS_F_LB_SS 
 [*]     Function filesystem (FunctionFS)                            #CONFIG_USB_CONFIGFS_F_FS  , FunctionFS  
 [ ]     HID function                                                     #CONFIG_USB_CONFIGFS_F_HID 
 [ ]     Printer function                                                 #CONFIG_USB_CONFIGFS_F_PRINTER  
 <m>   USB Gadget precomposed configurations // 아래부터,아래참조 drivers/usb/gadget/legacy/Kconfig               
 <m>     Gadget Zero (DEVELOPMENT)                                        #CONFIG_USB_ZERO      
 <m>     Ethernet Gadget (with CDC Ethernet support)                      #CONFIG_USB_ETH
 [*] RNDIS support                                                        #CONFIG_USB_ETH_RNDIS  
 [ ] Ethernet Emulation Model (EEM) support                               #CONFIG_USB_ETH_EEM 
 <m>     Network Control Model (NCM) support                              #CONFIG_USB_G_NCM 
 <m>     Gadget Filesystem                                              #CONFIG_USB_GADGETFS , GadgetFS
 <m>     Function Filesystem                                            #CONFIG_USB_FUNCTIONFS   
 [ ] Include configuration with CDC ECM (Ethernet)                             #CONFIG_USB_FUNCTIONFS_ETH 
 [ ] Include configuration with RNDIS (Ethernet)                               #CONFIG_USB_FUNCTIONFS_RNDIS 
 -*- Include 'pure' configuration                                         #CONFIG_USB_FUNCTIONFS_GENERIC 
 <m>     Mass Storage Gadget                                              #CONFIG_USB_MASS_STORAGE  
 <m>     Serial Gadget (with CDC ACM and CDC OBEX support)                #CONFIG_USB_G_SERIAL 
 < >     Printer Gadget                                                   #CONFIG_USB_G_PRINTER 
 < >     CDC Composite Device (Ethernet and ACM)                          #CONFIG_USB_CDC_COMPOSITE 
 < >     CDC Composite Device (ACM and mass storage)                      #CONFIG_USB_G_ACM_MS 
 <m>     Multifunction Composite Gadget                                   #CONFIG_USB_G_MULTI
 [*] RNDIS + CDC Serial + Storage configuration                                   #CONFIG_USB_G_MULTI_RNDIS
 [ ] CDC Ethernet + CDC Serial + Storage configuration                            #CONFIG_USB_G_MULTI_CDC
 < >     HID Gadget                                                       #CONFIG_USB_G_HID 
 < >     EHCI Debug Device Gadget                                         #CONFIG_USB_G_DBGP

Kernel USB Gadget/Function/Legacy Config 참조

https://github.com/torvalds/linux/blob/master/drivers/usb/gadget/Kconfig
https://github.com/torvalds/linux/blob/master/drivers/usb/gadget/legacy/Kconfig

CONFIG_USB_LIBCOMPOSITE 과 Gadget Function 기능

CONFIG_CONFIGFS_FS
CONFIG_USB_GADGET
상위 두개 선택시 자동 선택되며, 2개이상의 다중 USB Gadget Function 위해 사용
이 기능은 CONFIGFS의 FUNCTION 설정일 뿐이지 실제 Device가 아님

예를들면, RNDIS 필요하다면,

FUNCTION 설정 (CONFIG_USB_F_RNDIS)
CONFIG_USB_ETH_RNDIS도 필요

libcomposite (CONFIG_USB_LIBCOMPOSITE) 관련사용법

https://wiki.tizen.org/USB/Linux_USB_Layers/Configfs_Composite_Gadget

https://wiki.tizen.org/USB/Linux_USB_Layers/Configfs_Composite_Gadget/General_configuration

libcomposite USB Gadget Function 의 경우 USB Gadget 선택시 자동선택

https://github.com/torvalds/linux/blob/master/drivers/usb/gadget/Kconfig

https://github.com/torvalds/linux/blob/master/drivers/usb/gadget/function/Makefile

** UDC (USB Device Controller) Config

 > Device Drivers > USB support > USB Gadget Support > USB Peripheral Controller
 <m> Freescale Highspeed USB DR Peripheral Controller                     #CONFIG_USB_FSL_USB2
 < > Faraday FUSB300 USB Peripheral Controller
 < > Faraday FOTG210 USB Peripheral Controller 
 < > Aeroflex Gaisler GRUSBDC USB Peripheral Controller Driver
 < > Renesas R8A66597 USB Peripheral Controller 
 < > PXA 27x 
 < > Marvell USB2.0 Device Controller 
 < > MARVELL PXA2128 USB 3.0 controller
 < > Synopsys USB 2.0 Device controller
 < > Renesas M66592 USB Peripheral Controller
 < > Broadcom USB3.0 device controller IP driver(BDC)
 < > PLX NET2272  
 < > Xilinx USB Driver 
 < > Dummy HCD (DEVELOPMENT)

USB Gadget UDC Config

https://github.com/torvalds/linux/blob/master/drivers/usb/gadget/udc/Kconfig

USB Kernel Config

https://training.ti.com/sites/default/files/docs/USB-M2-MUSB-Kernel-Config_0.pdf

3. USB Gadget 설정기능확인

기본으로 sys file system으로 설정된 UDC 와 설정된 Kernel Module들을 확인하자.

더불어 Kernel Debug가 지원되면 관련부분도 설정하여 살펴보자.

USB 의 UDC (USB Device Controller) 확인

상위에 설정한 UDC의 기능정보 확인 및 이름확인

# UDC의 이름 확인 각 Chip Maker마다 이름이 다름 TI musb 이며 or 주소로도 표시됨 
# 상위 Device Tree에서 OTG 1은 OTG (ci_hdrc.0) 사용 , OTG 2는 Host Only (ci_hdrc.1) 
$ ls /sys/class/udc
ci_hdrc.0

# Chip Maker 마다 UDC에서 제공되는 기능으로 전부 다를 수 있음 
$ ls /sys/class/udc/ci_hdrc.0
a_alt_hnp_support  device             is_selfpowered     srp
a_hnp_support      function           maximum_speed      state
b_hnp_enable       is_a_peripheral    power              subsystem
current_speed      is_otg             soft_connect       uevent

# UDC의 Device 상태 
$ ls /sys/class/udc/ci_hdrc.0/device/
driver           modalias         subsystem
driver_override  power            udc
gadget           role             uevent

# UDC의 Device 미사용상태 (udevd 사용) 
$ cat /sys/class/udc/ci_hdrc.0/uevent
USB_UDC_NAME=2184000.usb

# UDC의 Device 미사용상태 
$ cat /sys/class/udc/ci_hdrc.0/current_speed
UNKNOWN

# UDC의 Device Legacy로 g_ether 설정상태 (속도확인가능) 
$ cat /sys/class/udc/ci_hdrc.0/current_speed
high-speed

# UDC의 Device Legacy로 g_ether 설정상태 (udevd 추후 함께 사용)
$ cat /sys/class/udc/ci_hdrc.0/uevent
DRIVER=g_ether
USB_UDC_NAME=2184000.usb
USB_UDC_DRIVER=g_ether

상위 (Kernel Device Tree의 otg1 -> ci_hdrc.0)

ci_hdrc.x 의 관련정보이며, chip vendor와 kernel version 마다 이름은 다를 수 있음 (주의)

https://www.kernel.org/doc/html/latest/usb/chipidea.html

https://elixir.bootlin.com/linux/v4.9/ident/ci_hdrc

USB Kernel Module 관련사항

현재 Function은 Module로 생성하지 않았으며, legcay 역시 내부적으로 Function을 호출하여 사용하고 동작한다.

# 각 usb gadget module 확인 (상위 Kernel에서 Module로 안했다면 없음) 
$ ls /lib/modules/$(uname -r)/kernel/drivers/usb/gadget/
legacy  udc

$ ls /lib/modules/$(uname -r)/kernel/drivers/usb/gadget/legacy
g_acm_ms.ko        g_ffs.ko           g_ncm.ko           gadgetfs.ko
g_cdc.ko           g_mass_storage.ko  g_serial.ko
g_ether.ko         g_multi.ko         g_zero.ko

$ ls /lib/modules/$(uname -r)/kernel/drivers/usb/gadget/udc
fsl_usb2_udc.ko

Kernel Debug On

USB Gadget Config FS로 설정한 상태로 확인

# Kernel Debug 기능이 동작이 되어야 하며, 상위 UDC 이름으로  간단히 Debug 
# mount -t debugfs none /sys/kernel/debug  , 자동 mount 함  (CONFIG_DEBUG_FS)
# https://www.linuxtopia.org/online_books/linux_kernel/kernel_configuration/ch09s07.html
# 

$ ls /sys/kernel/debug/ci_hdrc.0
device     port_test  qheads     registers  requests   role

$ cat /sys/kernel/debug/ci_hdrc.0/role
gadget

$ cat /sys/kernel/debug/ci_hdrc.0/device
speed             = 3
max_speed         = 3
is_otg            = 0
is_a_peripheral   = 0
b_hnp_enable      = 0
a_hnp_support     = 0
a_alt_hnp_support = 0
name              = 2184000.usb
gadget function   = g1
gadget max speed  = 5

11/08/2020

Yocto 의 Licence 정보확인 와 Build Space 구조

1. Yocto의 Licence 정보 와 Build 구조

Yocto 자체 Poky License (GPL/MIT)

Yocto의 내부의 Poky의 License

http://git.yoctoproject.org/cgit/cgit.cgi/poky/tree/LICENSE

Yocto 기본 사용
https://ahyuo79.blogspot.com/2015/10/yocto.html
https://ahyuo79.blogspot.com/2015/10/imx6.html

Yocto 기본문법 과 정리 (필독)
https://ahyuo79.blogspot.com/2020/01/raspberry-pi3-linux-yocto.html

Yocto Recipe 작성방법 (반드시 확인 및 이해)

https://ahyuo79.blogspot.com/2020/02/yocto-recipe.html

1.1 Yocto Source의 License 설정

Yocto의 기본인 poky에서 모든 LICENSE를 설정하는 곳이 별도로 존재하며,

이 기반으로 Recipe에서 선언을 하면 쉽게 License 관리가 된다.

Yocto의 licenses.conf 설정확인

Yocto의 Source에서 Licenses 관리 부분 SPDXLICENSEMAP 기반으로 Recipe에서 LICENSE로 관리되어짐

$ vi ./poky/meta/conf/licenses.conf

SRC_DISTRIBUTE_LICENSES += "AAL Adobe AFL-1.2 AFL-2.0 AFL-2.1 AFL-3.0"
SRC_DISTRIBUTE_LICENSES += "AGPL-3.0 ANTLR-PD Apache-1.0 Apache-1.1 Apache-2.0"
SRC_DISTRIBUTE_LICENSES += "APL-1.0 APSL-1.0 APSL-1.1 APSL-1.2 APSL-2.0"
SRC_DISTRIBUTE_LICENSES += "Artistic-1.0 Artistic-2.0 BitstreamVera BSD"
SRC_DISTRIBUTE_LICENSES += "BSD-2-Clause BSD-3-Clause BSD-4-Clause BSL-1.0"
SRC_DISTRIBUTE_LICENSES += "CATOSL-1.1 CC0-1.0 CC-BY-1.0 CC-BY-2.0 CC-BY-2.5"
SRC_DISTRIBUTE_LICENSES += "CC-BY-3.0 CC-BY-NC-1.0 CC-BY-NC-2.0 CC-BY-NC-2.5"
SRC_DISTRIBUTE_LICENSES += "CC-BY-NC-3.0 CC-BY-NC-ND-1.0 CC-BY-NC-ND-2.0"
SRC_DISTRIBUTE_LICENSES += "CC-BY-NC-ND-2.5 CC-BY-NC-ND-3.0 CC-BY-NC-SA-1.0"
SRC_DISTRIBUTE_LICENSES += "CC-BY-NC-SA-2.0 CC-BY-NC-SA-2.5 CC-BY-NC-SA-3.0"
SRC_DISTRIBUTE_LICENSES += "CC-BY-ND-1.0 CC-BY-ND-2.0 CC-BY-ND-2.5 CC-BY-ND-3.0"
SRC_DISTRIBUTE_LICENSES += "CC-BY-SA-1.0 CC-BY-SA-2.0 CC-BY-SA-2.5 CC-BY-SA-3.0 CC-BY-SA-4.0"
..........
# AGPL variations
SPDXLICENSEMAP[AGPL-3] = "AGPL-3.0"
SPDXLICENSEMAP[AGPLv3] = "AGPL-3.0"
SPDXLICENSEMAP[AGPLv3.0] = "AGPL-3.0"

# GPL variations
SPDXLICENSEMAP[GPL-1] = "GPL-1.0"
SPDXLICENSEMAP[GPLv1] = "GPL-1.0"
SPDXLICENSEMAP[GPLv1.0] = "GPL-1.0"
SPDXLICENSEMAP[GPL-2] = "GPL-2.0"
SPDXLICENSEMAP[GPLv2] = "GPL-2.0"
SPDXLICENSEMAP[GPLv2.0] = "GPL-2.0"
SPDXLICENSEMAP[GPL-3] = "GPL-3.0"
SPDXLICENSEMAP[GPLv3] = "GPL-3.0"
SPDXLICENSEMAP[GPLv3.0] = "GPL-3.0"

#LGPL variations
SPDXLICENSEMAP[LGPLv2] = "LGPL-2.0"
SPDXLICENSEMAP[LGPLv2.0] = "LGPL-2.0"
SPDXLICENSEMAP[LGPL2.1] = "LGPL-2.1"
SPDXLICENSEMAP[LGPLv2.1] = "LGPL-2.1"
SPDXLICENSEMAP[LGPLv3] = "LGPL-3.0"

#MPL variations
SPDXLICENSEMAP[MPL-1] = "MPL-1.0"
SPDXLICENSEMAP[MPLv1] = "MPL-1.0"
SPDXLICENSEMAP[MPLv1.1] = "MPL-1.1"
SPDXLICENSEMAP[MPLv2] = "MPL-2.0"
.........

Yocto의 License 관리하는 곳
  https://git.yoctoproject.org/cgit.cgi/poky/plain/meta/conf/licenses.conf

상위 SRC_DISTRIBUTE_LICENSES는 최신 Version에서는 사라짐
  https://www.yoctoproject.org/docs/latest/ref-manual/ref-manual.html#var-AVAILABLE_LICENSES
  https://www.yoctoproject.org/docs/latest/ref-manual/ref-manual.html#var-COMMON_LICENSE_DIR

1.2 Yocto Source의 Receipe 사용방법

상위 Config 기반으로 Recipe 적용하여 설정

Recipe 안에서 LICENSE 와 LIC_FILES_CHKSUM로 개별관리가 되므로 주의

Yocto의 Recipe 작성법 혹은 Config 설정확인
https://ahyuo79.blogspot.com/2020/02/yocto-recipe.html

Openembedded의 Recipe 부분 참조
https://www.openembedded.org/wiki/Recipe_License_Fields

2. Build Space 의 기본구조 확인

Build Space 기본구조 분석

Build Space 전체 기분구조 확인

$ tree -t -L 1 --charset unicode
or
$ tree -t -L 1 --charset utf8
.
|-- conf
|-- tmp
|-- sstate-cache
|-- cache
`-- bitbake-cookerdaemon.log

Build Space 의 User Config 확인

Build Space의 User Config 관련사항

https://ahyuo79.blogspot.com/2020/02/yocto-user-configuration.html

Source의 일반적인 Layer Config

https://ahyuo79.blogspot.com/2020/02/yocto-layer-configuration.html

$ tree -t -L 2 --charset unicode conf/   // Build Space의 User Config 
conf/
|-- local.conf.sample
|-- templateconf.cfg
|-- bblayers.conf.org
|-- local.conf
|-- local.conf.org
|-- bblayers.conf
`-- sanity_info

Build Space의 tmp 부분 구조

$ tree -t -d -L 2 --charset unicode tmp/
tmp/
|-- hosttools
|-- log
|   `-- cooker
|-- cache
|   `-- default-glibc
|-- stamps
|   |-- all-poky-linux
|   |-- cortexa9hf-neon-mx6sx-poky-linux-gnueabi
|   |-- cortexa9hf-neon-poky-linux-gnueabi
|   |-- imx6sxsabresd-poky-linux-gnueabi
|   |-- x86_64-linux
|   `-- work-shared
|-- work-shared
|   |-- gcc-8.3.0-r0
|   `-- imx6sxsabresd
|-- work
|   |-- cortexa9hf-neon-mx6sx-poky-linux-gnueabi
|   |-- all-poky-linux
|   |-- imx6sxsabresd-poky-linux-gnueabi
|   |-- cortexa9hf-neon-poky-linux-gnueabi
|   `-- x86_64-linux
|-- pkgdata
|   `-- imx6sxsabresd
|-- deploy
|   |-- images
|   |-- rpm
|   `-- licenses
|-- sysroots-components
|   |-- all
|   |-- x86_64
|   |-- cortexa9hf-neon-mx6sx
|   |-- imx6sxsabresd
|   |-- cortexa9hf-neon
|   `-- manifests
|-- buildstats
|   |-- 20201027081937
|   |-- 20201028005722
|   |-- 20201028012636
|   |-- 20201028015306
|   |-- 20201028015422
|   |-- 20201028015551
|   |-- 20201028020411
|   |-- 20201028022652
|   |-- 20201028023144
|   |-- 20201028023437
|   |-- 20201028033851
|   |-- 20201028041736
|   |-- 20201028060743
|   |-- 20201028071633
|   |-- 20201028071841
|   |-- 20201028073336
|   |-- 20201028073710
|   |-- 20201028073849
|   |-- 20201028075408
|   |-- 20201028080901
|   |-- 20201028081657
|   |-- 20201028085730
|   |-- 20201029082105
|   |-- 20201029085354
|   |-- 20201029085549
|   |-- 20201029085755
|   |-- 20201030043736
|   |-- 20201030080459
|   |-- 20201103084648
|   |-- 20201104015257
|   `-- 20201105060918
|-- sysroots
|   `-- imx6sxsabresd
`-- sstate-control

2.1 Build Space에서 License 정보확인

사용된 Package들의 License 조사

아래와 같이 찾아보면, tmp/deploy/licenses 에 기본적으로 Yocto에서 사용되어지는 Package들 License를 쉽게 찾을 수 있다.

그 아래를 보면 GCC License가 두 종료로 분리되어 나오

$ find . -name licenses
./tmp/deploy/licenses
./tmp/work/imx6sxsabresd-poky-linux-gnueabi/base-files/3.0.14-r89/licenses
./tmp/work/cortexa9hf-neon-poky-linux-gnueabi/util-linux/2.32.1-r0/util-linux-2.32.1/Documentation/licenses
./tmp/work/cortexa9hf-neon-poky-linux-gnueabi/gnutls/3.6.7-r0/gnutls-3.6.7/lib/extras/licenses
./tmp/work/x86_64-linux/util-linux-native/2.32.1-r0/util-linux-2.32.1/Documentation/license

사용되어지는 Package들의 License 정보확인

Build Space에서 실제 빌드된 Package 정보들이 확인 가능하며, deploy에 배포된 licenses 정보들이 별도로 관리가 되어진다.

이곳에서 관련 licenses 정보들을 확인

$ pwd                 // Yocto의 Build Space 위치 확인 

$ bitbake -h        // Yocto의 Build Space 설정상태확인 

$ ls tmp/deploy/licenses/             // Licenses 에서 사용된 Package 정보들 
acl                                           db                            kmod-native                m4                              qemu-native
alsa-lib                                      db-native                     m4-native                  qemuwrapper-cross
alsa-state                                    dbus                          ldconfig-native            make                            quilt-native
alsa-utils                                    dbus-glib                     libarchive-native          makedevs-native                 quota
attr                                          dbus-glib-native              libassuan-native           make-native                     re2c-native
attr-native                                   dbus-native                   libcap                     mdadm                           readline
autoconf-archive                              dbus-test                     libcheck                   meson-native                    readline-native
autoconf-archive-native                       debianutils-native            libcheck-native            minicom                         rng-tools
autoconf-native                               depmodwrapper-cross           libcomps-native            mklibs-native                   rpcbind
automake-native                               diffutils                     libdaemon                  mobile-broadband-provider-info  rpm-native
avahi                                         dnf-native                    libdnf-native              mpfr-native                     run-postinsts
base-files                                    dosfstools                    libffi                     mtools-native                   sed
base-passwd                                   dosfstools-native             libffi-native              ncurses                         shadow
bash                                          dtc-native                    libgcc                     ncurses-native                  shadow-native
bash-completion                               dwarfsrcfiles-native          libgcc-initial             neard                           shadow-securetty
bc                                            e2fsprogs                     libgcrypt                  netbase                         shadow-sysroot
bc-native                                     e2fsprogs-native              libgpg-error               nettle                          shared-mime-info
binutils                                      elfutils                      libgpg-error-native        ninja-native                    shared-mime-info-native
binutils-cross-arm                            elfutils-native               libical                    nspr-native                     socat
binutils-native                               expat                         libidn2                    nss-native                      sqlite3
bison                                         expat-native                  libjitterentropy           ofono                           sqlite3-native
bison-native                                  file-native                   libmnl                     openssh                         sudo
bluez5                                        firmware-imx                  libmodulemd-native         openssl                         swig-native
bmap-tools-native                             flac                          libmpc-native              openssl-native                  sysfsutils
btrfs-tools                                   flex                          libnl                      opkg-native                     systemd
busybox                                       flex-native                   libnsl2                    opkg-utils                      systemd-compat-units
bzip2                                         gawk                          libnsl2-native             opkg-utils-native               systemd-conf
bzip2-native                                  gcc-cross-arm                 libnss-mdns                optee-client-imx                systemd-serialgetty
ca-certificates                               gcc-runtime                   libogg                     optee-os-imx                    systemd-systemctl-native
chrpath-native                                gdbm                          libpcap                    optee-test-imx                  tcpdump
cmake-native                                  gdbm-native                   libpcre                    os-release                      tcp-wrappers
core-image-base                               gettext-minimal-native        libpcre-native             packagegroup-base               tele-set
core-image-base-imx6sxsabresd-20201027081937 gettext-native                librepo-native             packagegroup-core-boot          texinfo-dummy-native
........

$ ls tmp/deploy/licenses/u-boot-imx/
generic_GPLv2  gpl-2.0.txt  recipeinfo

$ ls tmp/deploy/licenses/gcc-cross-arm/
COPYING  COPYING3  COPYING3.LIB  COPYING.LIB  COPYING.RUNTIME  generic_GPL-3.0-with-GCC-exception  generic_GPLv3  recipeinfo

Image에서 사용되어진 License 확인

사용되어진 Image의 Package들의 License 정보를 알파벳순서로 확인가능하지만,

주의해야할 것은 모두 나오지는 않으며, 안나오는 것은 상위 Package에서 직접보자.

안나오는 경우는 LICENSE를 CLOSE해버리면 당연히 나오지 않게된다.

나의 경우 간단히 Uboot와 Yocto에서 사용되어지는 Python의 License들은 나오지 않았다.

$ bitbake -e | grep ^MACHINE_ARCH
MACHINE_ARCH="imx6sxsabresd"
MACHINE_ARCH_FILTER="virtual/kernel"

$ bitbake -e | grep ^TUNE_PKGARCH
TUNE_PKGARCH="cortexa9hf-neon"

$ bitbake -e | grep ^IMAGE

$ cat tmp/deploy/licenses/core-image-base-imx6sxsabresd-20201027081937/image_license.manifest
RECIPE NAME: linux-imx
VERSION: 4.19.35
LICENSE: GPLv2
FILES: imx6sx-sdb-ldo--4.19.35-r0-imx6sxsabresd-20201028015422.dtb imx6sx-sdb-mqs--4.19.35-r0-imx6sxsabresd-20201028015422.dtb imx6sx-sdb-btwifi--4.19.35-r0-imx6sxsabresd-20201028015422.dtb imx6sx-sdb-reva-ldo--4.19.35-r0-imx6sxsabresd-20201028015422.dtb imx6sx-sdb-reva--4.19.35-r0-imx6sxsabresd-20201028015422.dtb imx6sx-sdb-lcdif1--4.19.35-r0-imx6sxsabresd-20201028015422.dtb zImage--4.19.35-r0-imx6sxsabresd-20201028015422.bin imx6sx-sdb--4.19.35-r0-imx6sxsabresd-20201028015422.dtb modules--4.19.35-r0-imx6sxsabresd-20201028015422.tgz imx6sx-sdb-sai--4.19.35-r0-imx6sxsabresd-20201028015422.dtb imx6sx-sdb-emmc--4.19.35-r0-imx6sxsabresd-20201028015422.dtb imx6sx-sdb-m4--4.19.35-r0-imx6sxsabresd-20201028015422.dtb

RECIPE NAME: optee-os-imx
VERSION: git
LICENSE: BSD
FILES: uTee-6sxsdb tee.mx6sxsabresd.bin

RECIPE NAME: u-boot-imx
VERSION: 2019.04
LICENSE: GPLv2+
FILES: u-boot-emmc-2019.04-r0.imx


$ cat tmp/deploy/licenses/core-image-base-imx6sxsabresd-20201105060918/package.manifest
alsa-conf
alsa-state
alsa-states
alsa-utils-alsactl
alsa-utils-alsamixer
avahi-daemon
avahi-locale-en-gb
base-files
base-passwd
bash
binutils
bluez5
busybox
busybox-syslog
busybox-udhcpc
db
dbus-1
e2fsprogs-e2fsck
firmware-imx-sdma
glibc-locale-en-gb
imx-alsa-plugins
iptables
iptables-module-ebt-802-3
iptables-module-ebt-ip
iptables-module-ebt-log
iptables-module-ebt-mark-m
iptables-module-ip6t-ah
iptables-module-ip6t-dnat
iptables-module-ip6t-dnpt
iptables-module-ip6t-dst
iptables-module-ip6t-eui64
iptables-module-ip6t-frag
iptables-module-ip6t-hbh
iptables-module-ip6t-hl
iptables-module-ip6t-icmp6
iptables-module-ip6t-ipv6header
iptables-module-ip6t-log
iptables-module-ip6t-masquerade
......

$ cat tmp/deploy/licenses/core-lora-image-imx6sxsabresd-20201027081937/license.manifest
PACKAGE NAME: alsa-conf
PACKAGE VERSION: 1.1.8
RECIPE NAME: alsa-lib
LICENSE: LGPLv2.1 & GPLv2+

PACKAGE NAME: alsa-lib
PACKAGE VERSION: 1.1.8
RECIPE NAME: alsa-lib
LICENSE: LGPLv2.1 & GPLv2+

PACKAGE NAME: alsa-state
PACKAGE VERSION: 0.2.0
RECIPE NAME: alsa-state
LICENSE: MIT

PACKAGE NAME: alsa-states
PACKAGE VERSION: 0.2.0
RECIPE NAME: alsa-state
LICENSE: MIT

PACKAGE NAME: alsa-utils-alsactl
PACKAGE VERSION: 1.1.8
RECIPE NAME: alsa-utils
LICENSE: GPLv2+

PACKAGE NAME: alsa-utils-alsamixer
PACKAGE VERSION: 1.1.8
RECIPE NAME: alsa-utils
LICENSE: GPLv2+

PACKAGE NAME: avahi-daemon
PACKAGE VERSION: 0.7
RECIPE NAME: avahi
LICENSE: GPLv2+ & LGPLv2.1+

PACKAGE NAME: avahi-locale-en-gb
PACKAGE VERSION: 0.7
RECIPE NAME: avahi
LICENSE: GPLv2+ & LGPLv2.1+

PACKAGE NAME: base-files
PACKAGE VERSION: 3.0.14
RECIPE NAME: base-files
LICENSE: GPLv2

PACKAGE NAME: base-passwd
PACKAGE VERSION: 3.5.29
RECIPE NAME: base-passwd
LICENSE: GPLv2+
......

피드 구독하기: 글 ( Atom )