diff options
Diffstat (limited to 'communication_usb')
-rw-r--r-- | communication_usb/LICENSE | 177 | ||||
-rw-r--r-- | communication_usb/Makefile | 19 | ||||
-rw-r--r-- | communication_usb/client/Makefile | 43 | ||||
-rw-r--r-- | communication_usb/client/include/stub/commusb_api.h | 186 | ||||
-rw-r--r-- | communication_usb/client/include/stub/commusb_notifications.h | 56 | ||||
-rw-r--r-- | communication_usb/client/src/commusb_api.cpp | 33 |
6 files changed, 514 insertions, 0 deletions
diff --git a/communication_usb/LICENSE b/communication_usb/LICENSE new file mode 100644 index 00000000..f433b1a5 --- /dev/null +++ b/communication_usb/LICENSE @@ -0,0 +1,177 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS diff --git a/communication_usb/Makefile b/communication_usb/Makefile new file mode 100644 index 00000000..80a31b75 --- /dev/null +++ b/communication_usb/Makefile @@ -0,0 +1,19 @@ +# +# @copyright Copyright (c) 2019-2020 TOYOTA MOTOR CORPORATION. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +SUBDIRS := client + +include ../stub.mk diff --git a/communication_usb/client/Makefile b/communication_usb/client/Makefile new file mode 100644 index 00000000..fbefaedc --- /dev/null +++ b/communication_usb/client/Makefile @@ -0,0 +1,43 @@ +# +# @copyright Copyright (c) 2019-2020 TOYOTA MOTOR CORPORATION. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +######### installed shared library(*.so) ############# +INST_SHLIBS = libCommUSB + +######### install headers(*.h) ############# +INST_HEADERS = commusb_api.h commusb_notifications.h + +######### compiled sources ############# +libCommUSB_SRCS += src/commusb_api.cpp + +######### add source path ############# +VPATH += src +VPATH += include/stub + +######### add include path ############# +CPPFLAGS += -I./include +CPPFLAGS += -I./include/$(COMPONENT_NAME) + +######### add compile option ############# + +######### linked library ############# + +######### linked library (dynamic) ############# + +######### add library path ############# + + +include ../../stub.mk diff --git a/communication_usb/client/include/stub/commusb_api.h b/communication_usb/client/include/stub/commusb_api.h new file mode 100644 index 00000000..f602faac --- /dev/null +++ b/communication_usb/client/include/stub/commusb_api.h @@ -0,0 +1,186 @@ +/* + * @copyright Copyright (c) 2016-2020 TOYOTA MOTOR CORPORATION. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/*!----------------------------------------------------------------------------- + * @file commusb_api.h + * @~english + * @brief CommUSB I/F + */ +#ifndef COMMUNICATION_USB_CLIENT_INCLUDE_PERIPHERAL_SERVICE_COMMUSB_API_H_ +#define COMMUNICATION_USB_CLIENT_INCLUDE_PERIPHERAL_SERVICE_COMMUSB_API_H_ + +#include <sys/types.h> +#include <native_service/frameworkunified_types.h> + +/** @addtogroup BaseSystem + * @{ + */ +/** @addtogroup peripheral_service + * @ingroup BaseSystem + * @{ + */ +/** @addtogroup communication_usb + * @ingroup peripheral_service + * @{ + */ +#ifdef __cplusplus +extern "C" { +#endif // __cplusplus + +/** + * @~english Service Name of PS_CommUSB Thread + */ +#define LAN_SERVICE_COMMUSB_MAIN "PS_CommUSB" + +/** + * @~english The maximum number of delivery entry + */ +#define COMMUSB_DELIVERY_DATA_MAX 0xFF + +/** + * @~english Authentication info + */ +typedef enum { + /** + *@~english Authentication is NG + */ + COMMUSB_AUTH_NG = 0x00, + + /** + *@~english Authentication is OK + */ + COMMUSB_AUTH_OK +} COMMUSB_AUTH_INFO; + +/** + * @~english Transmit class + */ +typedef enum { + /** + *@~english Individual transmission + */ + COMMUSB_TRANS_INDIVIDUAL = 0x00, + + /** + *@~english Group broadcast transmission + */ + COMMUSB_TRANS_GROUP, + + /** + *@~english Simultaneous broadcast transmission + */ + COMMUSB_TRANS_ALL +} COMMUSB_TRANS_CLASS; + +/** + * @~english Clear type of DeliveryEntry table (for debug) + */ +typedef enum { + /** + * @~english Clear all + */ + USB_CLEAR_TYPE_ALL = 0, + + /** + * @~english Clear only table without wild card + */ + USB_CLEAR_TYPE_WITHOUT_WILDCARD, + + /** + * @~english Clear only table with wild card + */ + USB_CLEAR_TYPE_WITH_WILDCARD, +} USB_CLEAR_TYPE; + +/** + * \ingroup USB_Auth_Info + * \~english @par Brief + * Set the authentication status of the service PS_CommUSB. + * \~english @param [in] h_app + * HANDLE - handle for application + * \~english @param [in] auth_info + * uint8_t - Authentication status,refer to @ref COMMUSB_AUTH_INFO + * \~english @retval eFrameworkunifiedStatusOK success + * \~english @retval eFrameworkunifiedStatusInvldHandle Invalid handle + * \~english @retval eFrameworkunifiedStatusMsgQFull Message queue is full + * \~english @retval eFrameworkunifiedStatusErrNoEBADF Invalid File-Descriptor + * \~english @retval eFrameworkunifiedStatusErrNoEINTR + * An interrupt is generated by the system call (signal) + * \~english @retval eFrameworkunifiedStatusNullPointer NULL pointer + * \~english @retval eFrameworkunifiedStatusInvldParam Invalid parameter + * \~english @retval eFrameworkunifiedStatusInvldBufSize Invalid buffer-size + * \~english @retval eFrameworkunifiedStatusInvldBuf Invalid buffer + * \~english @retval eFrameworkunifiedStatusBadConnection It can not be a socket connection + * \~english @retval eFrameworkunifiedStatusFail Abnormal Error + * (System error, Avaiability is FALSE, internal status error) + * \~english @retval eFrameworkunifiedStatusInvldHndlType Invalid type of handle + * \~english @retval eFrameworkunifiedStatusInvldQName Illegal Message Queue name + * \~english @retval eFrameworkunifiedStatusErrOther + * Other error has occurred(Cannot access shared memory, etc.) + * \~english @par Preconditons + * - Availability of PS_CommUSB is TRUE and Authentication state is TRUE. + * \~english @par Change of internal status + * - Change of internal state according to the API does not occur + * \~english @par Conditions of processing failure + * - Input parameter error + * - Parameter h_app is null + * - eFrameworkunifiedStatusInvldHandle + * - Parameter auth_info is invalid + * - eFrameworkunifiedStatusInvldParam + * - Internal process error + * - Availability of PS_CommUSB is not TRUE + * - The size of the message received by PS_CommUSB is illegal + * - eFrameworkunifiedStatusFail + * - Execute the process name is not ExtUnitAuth + * - eFrameworkunifiedStatusMsgNotProcessed + * - Internal process error(ns_framework error) + * - eFrameworkunifiedStatusInvldHandle + * - eFrameworkunifiedStatusMsgQFull + * - eFrameworkunifiedStatusErrNoEBADF + * - eFrameworkunifiedStatusErrNoEINTR + * - eFrameworkunifiedStatusNullPointer + * - eFrameworkunifiedStatusInvldBufSize + * - eFrameworkunifiedStatusInvldBuf + * - eFrameworkunifiedStatusBadConnection + * - eFrameworkunifiedStatusFail + * - eFrameworkunifiedStatusInvldHndlType + * - eFrameworkunifiedStatusInvldQName + * - eFrameworkunifiedStatusErrOther + * \~english @par classification + * Public + * \~english @par Type + * Method only + * \~english @par Details + * Set the authentication status for PS_CommUSB. + * \~english @par + * when using this API,please note the following points: + * - The status of service PS_CommUSB and the availability of this + * API, refer to PS_CommUSB available function list of BaseSystem + * external specification. + * - This API is designed for the ExtUnitAuth process, If it is used by + * other process, return eFrameworkunifiedStatusMsgNotProcessed. + * \~english @see None + */ +EFrameworkunifiedStatus USB_Auth_Info(HANDLE h_app, uint8_t auth_info); + +#ifdef __cplusplus +} +#endif // __cplusplus + +/** @}*/ // end of communication_usb +/** @}*/ // end of peripheral_service +/** @}*/ // end of BaseSystem +#endif // COMMUNICATION_USB_CLIENT_INCLUDE_PERIPHERAL_SERVICE_COMMUSB_API_H_ diff --git a/communication_usb/client/include/stub/commusb_notifications.h b/communication_usb/client/include/stub/commusb_notifications.h new file mode 100644 index 00000000..9a75cbbc --- /dev/null +++ b/communication_usb/client/include/stub/commusb_notifications.h @@ -0,0 +1,56 @@ +/* + * @copyright Copyright (c) 2016-2020 TOYOTA MOTOR CORPORATION. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/** + * @file commusb_notifications.h + * @~english + * @brief commusb_notifications I/F + */ +#ifndef COMMUNICATION_USB_CLIENT_INCLUDE_PERIPHERAL_SERVICE_COMMUSB_NOTIFICATIONS_H_ +#define COMMUNICATION_USB_CLIENT_INCLUDE_PERIPHERAL_SERVICE_COMMUSB_NOTIFICATIONS_H_ + +/** @addtogroup BaseSystem + * @{ + */ +/** @addtogroup peripheral_service + * @ingroup BaseSystem + * @{ + */ +/** @addtogroup communication_usb + * @ingroup peripheral_service + * @{ + */ + +/** + * \~english PS_CommUSB service availability notify. + * \~ @code + * l_eStatus = FrameworkunifiedSubscribeNotificationWithCallback(hApp, NTFY_CommUSB_Availability, OnRcvAvailable_USBEx); + * @endcode + */ +#define NTFY_CommUSB_Availability "PS_CommUSB/Availability" + +/** + * \~english USB Device Enumeration complete notify. + * \~ @code + * l_eStatus = FrameworkunifiedSubscribeNotificationWithCallback(hApp, NTFY_CommUSB_DeviceValidity, OnRcvDeviceValidity); + * @endcode + */ +#define NTFY_CommUSB_DeviceValidity "PS_CommUSB/DeviceValidity" + +/** @}*/ // end of communication_usb +/** @}*/ // end of peripheral_service +/** @}*/ // end of BaseSystem +#endif // COMMUNICATION_USB_CLIENT_INCLUDE_PERIPHERAL_SERVICE_COMMUSB_NOTIFICATIONS_H_ diff --git a/communication_usb/client/src/commusb_api.cpp b/communication_usb/client/src/commusb_api.cpp new file mode 100644 index 00000000..c0aa0214 --- /dev/null +++ b/communication_usb/client/src/commusb_api.cpp @@ -0,0 +1,33 @@ +/* + * @copyright Copyright (c) 2016-2020 TOYOTA MOTOR CORPORATION. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/* + * Information. + * This source code is a sample source code . + * Implementation of the function must be performed by the vendor. + */ + +#include <native_service/frameworkunified_framework_if.h> +#include <stub/commusb_api.h> + +EFrameworkunifiedStatus USB_Auth_Info(HANDLE h_app, uint8_t auth_info) { + /* + * Note. + * This feature needs to be implemented by the vendor. + */ + return eFrameworkunifiedStatusOK; +} + |