1 /**
2  * \file
3  *
4  * \brief SAM Brown Out Detector Driver
5  *
6  * Copyright (C) 2015 Atmel Corporation. All rights reserved.
7  *
8  * \asf_license_start
9  *
10  * \page License
11  *
12  * Redistribution and use in source and binary forms, with or without
13  * modification, are permitted provided that the following conditions are met:
14  *
15  * 1. Redistributions of source code must retain the above copyright notice,
16  *    this list of conditions and the following disclaimer.
17  *
18  * 2. Redistributions in binary form must reproduce the above copyright notice,
19  *    this list of conditions and the following disclaimer in the documentation
20  *    and/or other materials provided with the distribution.
21  *
22  * 3. The name of Atmel may not be used to endorse or promote products derived
23  *    from this software without specific prior written permission.
24  *
25  * 4. This software may only be redistributed and used in connection with an
26  *    Atmel microcontroller product.
27  *
28  * THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR IMPLIED
29  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
30  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE
31  * EXPRESSLY AND SPECIFICALLY DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR
32  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
33  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
34  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
35  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
36  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
37  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
38  * POSSIBILITY OF SUCH DAMAGE.
39  *
40  * \asf_license_stop
41  *
42  */
43 /*
44  * Support and FAQ: visit <a href="http://www.atmel.com/design-support/">Atmel Support</a>
45  */
46 #include "bod.h"
47 
48 /**
49  * \brief Configure a Brown Out Detector module.
50  *
51  * Configures a given BOD module with the settings stored in the given
52  * configuration structure.
53  *
54  * \param[in] conf     Configuration settings to use for the specified BODVDD
55  *
56  * \retval STATUS_OK                  Operation completed successfully
57  * \retval STATUS_ERR_INVALID_ARG     An invalid BOD was supplied
58  * \retval STATUS_ERR_INVALID_OPTION  The requested BOD level was outside the acceptable range
59  */
bodvdd_set_config(struct bodvdd_config * const conf)60 enum status_code bodvdd_set_config(
61 		struct bodvdd_config *const conf)
62 {
63 	/* Sanity check arguments */
64 	Assert(conf);
65 
66 	uint32_t temp = 0;
67 
68 	/* Check if module is enabled. */
69 	if (SUPC->BODVDD.reg & SUPC_BODVDD_ENABLE) {
70 		SUPC->BODVDD.reg &= ~SUPC_BODVDD_ENABLE;
71 	}
72 
73 	/* Convert BOD prescaler, trigger action and mode to a bitmask */
74 	temp |= (uint32_t)conf->prescaler | (uint32_t)conf->action |
75 			(uint32_t)conf->mode_in_active | (uint32_t)conf->mode_in_standby;
76 
77 	if (conf->hysteresis == true) {
78 		temp |= SUPC_BODVDD_HYST;
79 	}
80 
81 	if (conf->run_in_standby == true) {
82 		temp |= SUPC_BODVDD_RUNSTDBY;
83 	}
84 
85 	if (conf->level > 0x3F) {
86 		return STATUS_ERR_INVALID_ARG;
87 	}
88 
89 	SUPC->BODVDD.reg = SUPC_BODVDD_LEVEL(conf->level) | temp;
90 
91 	return STATUS_OK;
92 }
93