1 /* 2 * Copyright (c) 2015, 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 __CCN_H__ 32 #define __CCN_H__ 33 34 /* 35 * This macro defines the maximum number of master interfaces that reside on 36 * Request nodes which the CCN driver can accommodate. The driver APIs to add 37 * and remove Request nodes from snoop/dvm domains take a bit map of master 38 * interfaces as inputs. The largest C data type that can be used is a 64-bit 39 * unsigned integer. Hence the value of 64. The platform will have to ensure 40 * that the master interfaces are numbered from 0-63. 41 */ 42 #define CCN_MAX_RN_MASTERS 64 43 44 /* 45 * The following constants define the various run modes that the platform can 46 * request the CCN driver to place the L3 cache in. These map to the 47 * programmable P-State values in a HN-F P-state register. 48 */ 49 #define CCN_L3_RUN_MODE_NOL3 0x0 /* HNF_PM_NOL3 */ 50 #define CCN_L3_RUN_MODE_SFONLY 0x1 /* HNF_PM_SFONLY */ 51 #define CCN_L3_RUN_MODE_HAM 0x2 /* HNF_PM_HALF */ 52 #define CCN_L3_RUN_MODE_FAM 0x3 /* HNF_PM_FULL */ 53 54 /* 55 * The following macro takes the value returned from a read of a HN-F P-state 56 * status register and returns the retention state value. 57 */ 58 #define CCN_GET_RETENTION_STATE(pstate) ((pstate >> 4) & 0x3) 59 60 /* 61 * The following macro takes the value returned from a read of a HN-F P-state 62 * status register and returns the run state value. 63 */ 64 #define CCN_GET_RUN_STATE(pstate) (pstate & 0xf) 65 66 #ifndef __ASSEMBLY__ 67 #include <stdint.h> 68 69 /* 70 * This structure describes some of the implementation defined attributes of the 71 * CCN IP. It is used by the platform port to specify these attributes in order 72 * to initialise the CCN driver. The attributes are described below. 73 * 74 * 1. The 'num_masters' field specifies the total number of master interfaces 75 * resident on Request nodes. 76 * 77 * 2. The 'master_to_rn_id_map' field is a ponter to an array in which each 78 * index corresponds to a master interface and its value corresponds to the 79 * Request node on which the master interface resides. 80 * This field is not simply defined as an array of size CCN_MAX_RN_MASTERS. 81 * In reality, a platform will have much fewer master * interfaces than 82 * CCN_MAX_RN_MASTERS. With an array of this size, it would also have to 83 * set the unused entries to a suitable value. Zeroing the array would not 84 * be enough since 0 is also a valid node id. Hence, such an array is not 85 * used. 86 * 87 * 3. The 'periphbase' field is the base address of the programmer's view of the 88 * CCN IP. 89 */ 90 typedef struct ccn_desc { 91 unsigned int num_masters; 92 const unsigned char *master_to_rn_id_map; 93 uintptr_t periphbase; 94 } ccn_desc_t; 95 96 97 void ccn_init(const ccn_desc_t *plat_ccn_desc); 98 void ccn_enter_snoop_dvm_domain(unsigned long long master_iface_map); 99 void ccn_exit_snoop_dvm_domain(unsigned long long master_iface_map); 100 void ccn_enter_dvm_domain(unsigned long long master_iface_map); 101 void ccn_exit_dvm_domain(unsigned long long master_iface_map); 102 void ccn_set_l3_run_mode(unsigned int mode); 103 void ccn_program_sys_addrmap(unsigned int sn0_id, 104 unsigned int sn1_id, 105 unsigned int sn2_id, 106 unsigned int top_addr_bit0, 107 unsigned int top_addr_bit1, 108 unsigned char three_sn_en); 109 unsigned int ccn_get_l3_run_mode(void); 110 111 #endif /* __ASSEMBLY__ */ 112 #endif /* __CCN_H__ */ 113