Fix kernel version detection
[profile/ivi/OpenAVB.git] / README.rst
1 Open AVB
2 ========
3 maintainer: eric.mann AT intel.com
4
5 Intel created the Open AVB repository to encourage collaborative source code 
6 development for AVB technology enabling. By publishing the source code, our 
7 intent is to encourage standardization, stability and inter-operability between 
8 multiple vendors. This repository - created by the Intel LAN Access Division - 
9 is open for contributions from other vendors. The repository contains primarily 
10 network building block components - drivers, libraries, example applications 
11 and daemon source code - required to build an AVB system. It is planned to 
12 eventually include the various packet encapsulation types, protocol discovery 
13 daemons, libraries to convert media clocks to AVB clocks (and vice 
14 versa), and drivers.
15
16 This repository does not include all components required to build a full 
17 production AVB system (e.g. a turnkey solution to stream stored or live audio 
18 or video content). Some simple example applications are provided which 
19 illustrate the flow - but a professional AVB system requires a full media stack 
20 - including audio and video inputs and outputs, media processing elements, and 
21 various graphical user interfaces. Various companies provide such integrated 
22 solutions.
23
24 For more information about AVB, see also the AVnu Alliance webpage at
25 www.avnu.org.
26
27 LICENSING AND CONTRIBUTION GUIDELINES
28 ======================================
29 To the extent possible, content is licensed under BSD licensing terms. Linux 
30 kernel mode components are provided under a GPLv2 license. The specific license 
31 information is included in the various directories to eliminate confusion. We 
32 encourage you to review the ‘LICENSE’ file included in the head of the 
33 various subdirectories for details.
34
35 Third party submissions are welcomed. Our intent for third party content 
36 contributions is to enable derivative products with minimal licensing 
37 entanglements. Practically speaking, this means we would enforce (a) an 
38 original-source attestation for any contributed content, and (b) rejecting 
39 patches with GPL content into existing “BSD” licensed components. Third 
40 party copyrights can be included provided they do not narrow the licensing 
41 terms of an existing component.
42
43 Prior to accepting a commit, Intel may perform scans using third-party tools 
44 to identify suspected hits of GPL code. Intel may also perform vulnerability 
45 scans of patches in an attempt to find various coding errors such as memory 
46 leaks, buffer overflows and usage of uninitialized variables. The submitter 
47 will be asked to correct any detected issues prior to a commit. Owners
48 of submitted third-party content are free to apply changes without supervision
49 by Intel.
50
51 The Open AVB project has a development mailing list. To subscribe, visit
52 https://lists.sourceforge.net/lists/listinfo/open-avb-devel to sign up.
53
54 RELATED OPEN SOURCE PROJECTS
55 ============================
56
57 AVDECC
58 ------
59 Jeff Koftinoff maintains a repository of AVDECC example open 
60 source code. AVDECC is a management layer, similar to SNMP MIB formats, 
61 which enables remote devices to detect, enumerate and configure AVB-related 
62 devices based on their standardized management properties.
63
64 + https://github.com/jdkoftinoff/jdksavdecc-c
65
66 XMOS
67 ----
68 XMOS is a semiconductor company providing a reference design for AVB 
69 endpoints in pro audio and automotive. Our source code is open source 
70 and available on Github - https://github.com/xcore/sw_avb
71