1/*
2 * Copyright (c) 2013-2014, ARM Limited and Contributors. All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are met:
6 *
7 * Redistributions of source code must retain the above copyright notice, this
8 * list of conditions and the following disclaimer.
9 *
10 * Redistributions in binary form must reproduce the above copyright notice,
11 * this list of conditions and the following disclaimer in the documentation
12 * and/or other materials provided with the distribution.
13 *
14 * Neither the name of ARM nor the names of its contributors may be used
15 * to endorse or promote products derived from this software without specific
16 * prior written permission.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
22 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28 * POSSIBILITY OF SUCH DAMAGE.
29 */
30
31#ifndef __BAKERY_LOCK_H__
32#define __BAKERY_LOCK_H__
33
34#include <platform_def.h>
35
36#define BAKERY_LOCK_MAX_CPUS		PLATFORM_CORE_COUNT
37
38#ifndef __ASSEMBLY__
39#include <stdint.h>
40
41#if USE_COHERENT_MEM
42
43typedef struct bakery_lock {
44	int owner;
45	volatile char entering[BAKERY_LOCK_MAX_CPUS];
46	volatile unsigned number[BAKERY_LOCK_MAX_CPUS];
47} bakery_lock_t;
48
49#define NO_OWNER (-1)
50
51void bakery_lock_init(bakery_lock_t *bakery);
52void bakery_lock_get(bakery_lock_t *bakery);
53void bakery_lock_release(bakery_lock_t *bakery);
54int bakery_lock_try(bakery_lock_t *bakery);
55
56#else
57
58typedef struct bakery_info {
59	/*
60	 * The lock_data is a bit-field of 2 members:
61	 * Bit[0]       : choosing. This field is set when the CPU is
62	 *                choosing its bakery number.
63	 * Bits[1 - 15] : number. This is the bakery number allocated.
64	 */
65	volatile uint16_t lock_data;
66} bakery_info_t;
67
68void bakery_lock_get(unsigned int id, unsigned int offset);
69void bakery_lock_release(unsigned int id, unsigned int offset);
70
71#endif /* __USE_COHERENT_MEM__ */
72#endif /* __ASSEMBLY__ */
73#endif /* __BAKERY_LOCK_H__ */
74