1
1
# How to Port the Azure IoT C SDK to Other Platforms
2
2
3
- This document shows how to port the C Shared utility library to
4
- platforms not supported out of the box.
5
- The C shared utility library is used by C SDKs like IoTHub client SDK and EventHub client SDK.
3
+ This document shows how to port the C Shared Utility library to
4
+ platforms that are not already supported.
5
+
6
+ The C Shared Utility library is used by C SDKs like IoTHub client SDK and EventHub client SDK.
7
+
8
+ This document does not provide specific guidance for how to compile the Azure IoT
9
+ libraries on any specific system. Most newly targeted systems will not support CMake, which
10
+ is the SDK's preferred build system, so it is likely that newly targeted systems
11
+ will need to have a makefile or the equivalent created by hand.
6
12
7
13
## References
8
14
9
- ###### Specifications
15
+ - [ TLS adapter architecture overview] ( tlsio_adapter_overview.md ) .
16
+ - [ TLS adapter implementers guide] ( tls_adapter_implementers_guide.md ) .
10
17
- [ threadapi and sleep adapter specification] ( threadapi_and_sleep_requirements.md ) <br />
11
18
- [ lock adapter specification] ( lock_requirements.md ) <br />
12
19
@@ -28,15 +35,14 @@ The following sections describe each step in detail.
28
35
### Step 1 &ndash ; Include common porting files and headers
29
36
30
37
The common porting source files are found in the C shared utility library's
31
- ` pal ` directory. Include these three files:
38
+ ` pal ` directory. Include these three files in your project :
32
39
* ` tlsio_adapter_common.c `
33
40
* ` tlsio_options.c `
34
41
* ` tickcounter.c `
35
42
36
- The headers for the common porting files are found in the ` pal ` directory. Add these two
37
- paths to your project header include directories:
43
+ The headers for the common porting files are found in the ` pal ` directory. Add this
44
+ path to your project header include directories:
38
45
* ` pal/inc `
39
- * ` pal/generic `
40
46
41
47
42
48
### Step 2 &ndash ; Implement the required platform functions
@@ -118,8 +124,8 @@ that you can modify for this purpose.
118
124
The Azure IoT Hub requires secure communication over TLS. The Azure IoT SDK uses
119
125
a layered architecture that makes it simple to implement TLS for new devices.
120
126
121
- If you're curious about the layered architecture, it is discussed
122
- [ in this overview] ( tlsio_adapter_overview.md ) .
127
+ If you're curious about the layered architecture, it is discussed in
128
+ [ this overview] ( tlsio_adapter_overview.md ) .
123
129
124
130
Details of how to implement TLS communication are in
125
131
[ this implementers guide] ( tls_adapter_implementers_guide.md ) .
0 commit comments