LM3643 Initial Commit : Synchronous Boost Dual LED Flash Driver
[windows-iot-driver/drivers.git] / LM3643 / TxnwLedLm3643 / spb.h
1 /*++\r
2 The Microsoft Public License (MS-PL)\r
3 Copyright (c) 2015 Microsoft\r
4 \r
5 This license governs use of the accompanying software. If you use the software, you\r
6 accept this license. If you do not accept the license, do not use the software.\r
7 \r
8 1. Definitions\r
9 The terms "reproduce," "reproduction," "derivative works," and "distribution" have\r
10 the same meaning here as under U.S. copyright law.\r
11 A "contribution" is the original software, or any additions or changes to the software.\r
12 A "contributor" is any person that distributes its contribution under this license.\r
13 "Licensed patents" are a contributor's patent claims that read directly on its contribution.\r
14 \r
15 2. Grant of Rights\r
16 (A) Copyright Grant- Subject to the terms of this license, including the license conditions\r
17 and limitations in section 3, each contributor grants you a non-exclusive, worldwide,\r
18 royalty-free copyright license to reproduce its contribution, prepare derivative works of\r
19 its contribution, and distribute its contribution or any derivative works that you create.\r
20 (B) Patent Grant- Subject to the terms of this license, including the license conditions\r
21 and limitations in section 3, each contributor grants you a non-exclusive, worldwide,\r
22 royalty-free license under its licensed patents to make, have made, use, sell, offer for\r
23 sale, import, and/or otherwise dispose of its contribution in the software or derivative\r
24 works of the contribution in the software.\r
25 \r
26 3. Conditions and Limitations\r
27 (A) No Trademark License- This license does not grant you rights to use any contributors'\r
28 name, logo, or trademarks.\r
29 (B) If you bring a patent claim against any contributor over patents that you claim are\r
30 infringed by the software, your patent license from such contributor to the software ends\r
31 automatically.\r
32 (C) If you distribute any portion of the software, you must retain all copyright, patent,\r
33 trademark, and attribution notices that are present in the software.\r
34 (D) If you distribute any portion of the software in source code form, you may do so only\r
35 under this license by including a complete copy of this license with your distribution.\r
36 If you distribute any portion of the software in compiled or object code form, you may\r
37 only do so under a license that complies with this license.\r
38 (E) The software is licensed "as-is." You bear the risk of using it. The contributors\r
39 give no express warranties, guarantees or conditions. You may have additional consumer\r
40 rights under your local laws which this license cannot change. To the extent permitted\r
41 under your local laws, the contributors exclude the implied warranties of merchantability,\r
42 fitness for a particular purpose and non-infringement.\r
43 Sample code. Dealpoint ID #843729.\r
44 \r
45 Module Name:\r
46 \r
47 spb.h\r
48 \r
49 Abstract:\r
50 \r
51 This module contains the touch driver I2C helper definitions.\r
52 \r
53 Environment:\r
54 \r
55 Kernel Mode\r
56 \r
57 Revision History:\r
58     Modified for LED driver. \r
59 \r
60 --*/\r
61 \r
62 #pragma once\r
63 \r
64 #include <wdm.h>\r
65 #include <wdf.h>\r
66 \r
67 #define DEFAULT_SPB_BUFFER_SIZE 64\r
68 \r
69 //\r
70 // SPB (I2C) context\r
71 //\r
72 \r
73 typedef struct _SPB_CONTEXT\r
74 {\r
75         WDFIOTARGET SpbIoTarget;\r
76         LARGE_INTEGER I2cResHubId;\r
77         WDFMEMORY WriteMemory;\r
78         WDFMEMORY ReadMemory;\r
79         WDFWAITLOCK SpbLock;\r
80 } SPB_CONTEXT;\r
81 \r
82 NTSTATUS\r
83 SpbReadDataSynchronously(\r
84         _In_ SPB_CONTEXT *SpbContext,\r
85         _In_ UCHAR Address,\r
86         _In_reads_bytes_(Length) PVOID Data,\r
87         _In_ ULONG Length\r
88         );\r
89 \r
90 VOID\r
91 SpbTargetDeinitialize(\r
92         IN WDFDEVICE FxDevice,\r
93         IN SPB_CONTEXT *SpbContext\r
94         );\r
95 \r
96 NTSTATUS\r
97 SpbTargetInitialize(\r
98         IN WDFDEVICE FxDevice,\r
99         IN SPB_CONTEXT *SpbContext\r
100         );\r
101 \r
102 NTSTATUS\r
103 SpbWriteDataSynchronously(\r
104         IN SPB_CONTEXT *SpbContext,\r
105         IN UCHAR Address,\r
106         IN PVOID Data,\r
107         IN ULONG Length\r
108         );\r