Maxim Integrated / Mbed OS MAXREFDES155#

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   MaximInterface

Factory.hpp@12:46c5974a565f, 2017-06-01 (annotated)

Committer:
IanBenzMaxim
Date:
Thu Jun 01 14:21:58 2017 -0500
Revision:
12:46c5974a565f
Parent:
0:33d4e66780c0
Child:
13:6a6225690c2e
Added bidirectional challenge support.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
IanBenzMaxim 0:33d4e66780c0 1 /*******************************************************************************
IanBenzMaxim 0:33d4e66780c0 2 * Copyright (C) 2017 Maxim Integrated Products, Inc., All Rights Reserved.
IanBenzMaxim 0:33d4e66780c0 3 *
IanBenzMaxim 0:33d4e66780c0 4 * Permission is hereby granted, free of charge, to any person obtaining a
IanBenzMaxim 0:33d4e66780c0 5 * copy of this software and associated documentation files (the "Software"),
IanBenzMaxim 0:33d4e66780c0 6 * to deal in the Software without restriction, including without limitation
IanBenzMaxim 0:33d4e66780c0 7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
IanBenzMaxim 0:33d4e66780c0 8 * and/or sell copies of the Software, and to permit persons to whom the
IanBenzMaxim 0:33d4e66780c0 9 * Software is furnished to do so, subject to the following conditions:
IanBenzMaxim 0:33d4e66780c0 10 *
IanBenzMaxim 0:33d4e66780c0 11 * The above copyright notice and this permission notice shall be included
IanBenzMaxim 0:33d4e66780c0 12 * in all copies or substantial portions of the Software.
IanBenzMaxim 0:33d4e66780c0 13 *
IanBenzMaxim 0:33d4e66780c0 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
IanBenzMaxim 0:33d4e66780c0 15 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
IanBenzMaxim 0:33d4e66780c0 16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IanBenzMaxim 0:33d4e66780c0 17 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
IanBenzMaxim 0:33d4e66780c0 18 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
IanBenzMaxim 0:33d4e66780c0 19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
IanBenzMaxim 0:33d4e66780c0 20 * OTHER DEALINGS IN THE SOFTWARE.
IanBenzMaxim 0:33d4e66780c0 21 *
IanBenzMaxim 0:33d4e66780c0 22 * Except as contained in this notice, the name of Maxim Integrated
IanBenzMaxim 0:33d4e66780c0 23 * Products, Inc. shall not be used except as stated in the Maxim Integrated
IanBenzMaxim 0:33d4e66780c0 24 * Products, Inc. Branding Policy.
IanBenzMaxim 0:33d4e66780c0 25 *
IanBenzMaxim 0:33d4e66780c0 26 * The mere transfer of this software does not imply any licenses
IanBenzMaxim 0:33d4e66780c0 27 * of trade secrets, proprietary technology, copyrights, patents,
IanBenzMaxim 0:33d4e66780c0 28 * trademarks, maskwork rights, or any other form of intellectual
IanBenzMaxim 0:33d4e66780c0 29 * property whatsoever. Maxim Integrated Products, Inc. retains all
IanBenzMaxim 0:33d4e66780c0 30 * ownership rights.
IanBenzMaxim 0:33d4e66780c0 31 *******************************************************************************/
IanBenzMaxim 0:33d4e66780c0 32
IanBenzMaxim 0:33d4e66780c0 33 /// @file Contains provisioning commands for the DS2476 and DS28C36.
IanBenzMaxim 0:33d4e66780c0 34 /// Provisioning would typically be performed separately at a secure location during the device
IanBenzMaxim 0:33d4e66780c0 35 /// manufacturing stage.
IanBenzMaxim 0:33d4e66780c0 36
IanBenzMaxim 0:33d4e66780c0 37 #ifndef FACTORY_HPP
IanBenzMaxim 0:33d4e66780c0 38 #define FACTORY_HPP
IanBenzMaxim 0:33d4e66780c0 39
IanBenzMaxim 0:33d4e66780c0 40 class DS2476;
IanBenzMaxim 0:33d4e66780c0 41 class DS28C36;
IanBenzMaxim 0:33d4e66780c0 42
IanBenzMaxim 0:33d4e66780c0 43 /// Provision the specified DS28C36 for this application.
IanBenzMaxim 0:33d4e66780c0 44 /// @returns True if the provisioning was successful.
IanBenzMaxim 0:33d4e66780c0 45 bool provisionAuthenticator(DS28C36 & ds28c36);
IanBenzMaxim 0:33d4e66780c0 46
IanBenzMaxim 0:33d4e66780c0 47 /// Provision the specified DS2476 for this application.
IanBenzMaxim 0:33d4e66780c0 48 /// @returns True if the provisioning was successful.
IanBenzMaxim 0:33d4e66780c0 49 bool provisionCoprocessor(DS2476 & ds2476);
IanBenzMaxim 0:33d4e66780c0 50
IanBenzMaxim 0:33d4e66780c0 51 /// Check if the coprocessor is provisioned.
IanBenzMaxim 0:33d4e66780c0 52 /// @param provisioned True if the sensor board is provisioned.
IanBenzMaxim 0:33d4e66780c0 53 /// @returns True if provisioning check was successful.
IanBenzMaxim 0:33d4e66780c0 54 bool checkAuthenticatorProvisioned(DS28C36 & ds28c36, bool & provisioned);
IanBenzMaxim 0:33d4e66780c0 55
IanBenzMaxim 0:33d4e66780c0 56 /// Check if the coprocessor is provisioned.
IanBenzMaxim 0:33d4e66780c0 57 /// @param provisioned True if the sensor board is provisioned.
IanBenzMaxim 0:33d4e66780c0 58 /// @returns True if provisioning check was successful.
IanBenzMaxim 0:33d4e66780c0 59 bool checkCoprocessorProvisioned(DS2476 & ds2476, bool & provisioned);
IanBenzMaxim 0:33d4e66780c0 60
IanBenzMaxim 0:33d4e66780c0 61 #endif