1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
|
/***********************license start***********************************
* Copyright (c) 2003-2017 Cavium Inc. (support@cavium.com). All rights
* reserved.
*
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* * Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following
* disclaimer in the documentation and/or other materials provided
* with the distribution.
*
* * Neither the name of Cavium Inc. nor the names of
* its contributors may be used to endorse or promote products
* derived from this software without specific prior written
* permission.
*
* This Software, including technical data, may be subject to U.S. export
* control laws, including the U.S. Export Administration Act and its
* associated regulations, and may be subject to export or import
* regulations in other countries.
*
* TO THE MAXIMUM EXTENT PERMITTED BY LAW, THE SOFTWARE IS PROVIDED "AS IS"
* AND WITH ALL FAULTS AND CAVIUM INC. MAKES NO PROMISES, REPRESENTATIONS OR
* WARRANTIES, EITHER EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE, WITH RESPECT
* TO THE SOFTWARE, INCLUDING ITS CONDITION, ITS CONFORMITY TO ANY
* REPRESENTATION OR DESCRIPTION, OR THE EXISTENCE OF ANY LATENT OR PATENT
* DEFECTS, AND CAVIUM SPECIFICALLY DISCLAIMS ALL IMPLIED (IF ANY) WARRANTIES
* OF TITLE, MERCHANTABILITY, NONINFRINGEMENT, FITNESS FOR A PARTICULAR
* PURPOSE, LACK OF VIRUSES, ACCURACY OR COMPLETENESS, QUIET ENJOYMENT,
* QUIET POSSESSION OR CORRESPONDENCE TO DESCRIPTION. THE ENTIRE RISK
* ARISING OUT OF USE OR PERFORMANCE OF THE SOFTWARE LIES WITH YOU.
***********************license end**************************************/
#include "libbdk-arch/bdk-csrs-sgp.h"
/**
* @file
*
* Serial GPIO interface (SGPIO)
*
* <hr>$Revision: 49448 $<hr>
*
* @addtogroup hal
* @{
*/
#ifndef _BDK_DRIVER_SGPIO_H_
#define _BDK_DRIVER_SGPIO_H_
typedef enum
{
BDK_SGPIO_LED_ACT,
BDK_SGPIO_LED_LOC,
BDK_SGPIO_LED_ERR,
} bdk_sgpio_led_t;
typedef enum
{
BDK_SGPIO_STATIC_ON = BDK_SGP_TX_ACT_E_STATIC_ON,
BDK_SGPIO_STATIC_OFF = BDK_SGP_TX_ACT_E_STATIC_OFF,
BDK_SGPIO_BLINK = BDK_SGP_TX_ACT_E_A_ON_OFF,
} bdk_sgpio_led_state_t;
/**
* Get the SGPIO controller state
*
* @param node CPU node number
*
* @return 1 == Controller is enabled, 0 == Controller is disabled
*/
int bdk_sgpio_is_enabled(bdk_node_t node);
/**
* Set the mode for a specific LED.
*
* @param node CPU node number
* @param drive Drive number of LED (0-15)
* @param led LED type:
* BDK_SGPIO_LED_ACT
* BDK_SGPIO_LED_ERR
* BDK_SGPIO_LED_LOC
*
* @return
*/
void bdk_sgpio_set_led_state(bdk_node_t node, int drive, int led, int state);
/**
* Get the mode for a specific LED.
*
* @param node CPU node number
* @param drive Drive number of LED (0-15)
* @param led LED type:
* BDK_SGPIO_LED_ACT
* BDK_SGPIO_LED_ERR
* BDK_SGPIO_LED_LOC
*
* @return LED state:
* BDK_SGPIO_STATIC_ON
* BDK_SGPIO_STATIC_OFF
* BDK_SGPIO_BLINK
*/
int bdk_sgpio_get_led_state(bdk_node_t node, int drive, int led);
/**
* Set the controller's SCLOCK frequency
*
* @param node CPU node number
* @param freq Frequency to set
*
* @return Zero on success, negative on failure
*/
int bdk_sgpio_set_sclock(bdk_node_t node, int freq);
/**
* Enable / disable controller
*
* @param node CPU node number
* @param ena zero = disable, non-zero = enable
*
* @return
*/
void bdk_sgpio_enable_controller(bdk_node_t node, int ena);
/**
* Set up SGPIO pin muxing based on environment.
*
* @param node CPU node number
*
* @return Zero on success, negative on failure
*/
int bdk_sgpio_setup_gpio_pins(bdk_node_t node);
/**
* Initialize the SGPIO controller.
* - Set up the SGPIO pin muxing as per configuration environment.
* - Turn all LEDs off
* - Set the blink rate to 1/2 second
* - Enable the controller
*
* @param node CPU node number
*
* @return Zero on success, negative on failure
*/
int bdk_sgpio_initialize(bdk_node_t node);
/** @} */
#endif /* _BDK_DRIVER_SGPIO_H_ */
|
