summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorpatacongo <patacongo@42af7a65-404d-4744-a932-0658087f49c3>2012-07-30 16:51:43 +0000
committerpatacongo <patacongo@42af7a65-404d-4744-a932-0658087f49c3>2012-07-30 16:51:43 +0000
commit505963a3568ba0dc23cb0cb7b3efee58f83a49ea (patch)
tree41f9e4861aa9914bbcf36241710b609ce1681ba1
parente3feaf63eccee5e555ab006d7f8216057cd1e31b (diff)
downloadnuttx-505963a3568ba0dc23cb0cb7b3efee58f83a49ea.tar.gz
nuttx-505963a3568ba0dc23cb0cb7b3efee58f83a49ea.tar.bz2
nuttx-505963a3568ba0dc23cb0cb7b3efee58f83a49ea.zip
Add support for testing multiple ADC, PWM, and QE devices
git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@4993 42af7a65-404d-4744-a932-0658087f49c3
-rwxr-xr-xapps/ChangeLog.txt2
-rw-r--r--apps/examples/README.txt4
-rw-r--r--apps/examples/adc/adc.h11
-rw-r--r--apps/examples/adc/adc_main.c209
-rw-r--r--apps/examples/pwm/pwm_main.c58
-rw-r--r--apps/examples/qencoder/qe.h8
-rw-r--r--apps/examples/qencoder/qe_main.c72
-rw-r--r--nuttx/arch/arm/src/stm32/stm32_qencoder.c4
-rw-r--r--nuttx/configs/stm3210e-eval/src/up_pmbuttons.c2
9 files changed, 303 insertions, 67 deletions
diff --git a/apps/ChangeLog.txt b/apps/ChangeLog.txt
index e24d0472d..fa476a06d 100755
--- a/apps/ChangeLog.txt
+++ b/apps/ChangeLog.txt
@@ -263,3 +263,5 @@
return value from spawned applications (provided by Mike Smith)
* apps/nslib: Lock the schedule while starting built-in applications
in order to eliminate race conditions (also from Mike Smith).
+ * apps/examples/adc, pwm, and qencoder: Add support for testing
+ devices with multiple ADC, PWM, and QE devices.
diff --git a/apps/examples/README.txt b/apps/examples/README.txt
index 37d63786f..7d068f979 100644
--- a/apps/examples/README.txt
+++ b/apps/examples/README.txt
@@ -45,7 +45,7 @@ examples/adc
Specific configuration options for this example include:
- CONFIG_EXAMPLES_ADC_DEVPATH - The path to the ADC device. Default: /dev/adc0
+ CONFIG_EXAMPLES_ADC_DEVPATH - The default path to the ADC device. Default: /dev/adc0
CONFIG_EXAMPLES_ADC_NSAMPLES - If CONFIG_NSH_BUILTIN_APPS
is defined, then the number of samples is provided on the command line
and this value is ignored. Otherwise, this number of samples is
@@ -1059,7 +1059,7 @@ examples/pwm
Specific configuration options for this example include:
- CONFIG_EXAMPLES_PWM_DEVPATH - The path to the PWM device. Default: /dev/pwm0
+ CONFIG_EXAMPLES_PWM_DEVPATH - The path to the default PWM device. Default: /dev/pwm0
CONFIG_EXAMPLES_PWM_FREQUENCY - The initial PWM frequency. Default: 100 Hz
CONFIG_EXAMPLES_PWM_DUTYPCT - The initial PWM duty as a percentage. Default: 50%
CONFIG_EXAMPLES_PWM_DURATION - The initial PWM pulse train duration in seconds.
diff --git a/apps/examples/adc/adc.h b/apps/examples/adc/adc.h
index 214ecc6c8..9f79db92a 100644
--- a/apps/examples/adc/adc.h
+++ b/apps/examples/adc/adc.h
@@ -48,7 +48,7 @@
/* Configuration ************************************************************/
/* CONFIG_NSH_BUILTIN_APPS - Build the ADC test as an NSH built-in function.
* Default: Built as a standalone problem
- * CONFIG_EXAMPLES_ADC_DEVPATH - The path to the ADC device. Default: /dev/adc0
+ * CONFIG_EXAMPLES_ADC_DEVPATH - The default path to the ADC device. Default: /dev/adc0
* CONFIG_EXAMPLES_ADC_NSAMPLES - If CONFIG_NSH_BUILTIN_APPS
* is defined, then the number of samples is provided on the command line
* and this value is ignored. Otherwise, this number of samples is
@@ -94,6 +94,15 @@
* Public Types
****************************************************************************/
+struct adc_state_s
+{
+ bool initialized;
+ FAR char *devpath;
+#if defined(CONFIG_NSH_BUILTIN_APPS) || defined(CONFIG_EXAMPLES_ADC_NSAMPLES)
+ int count;
+#endif
+};
+
/****************************************************************************
* Public Variables
****************************************************************************/
diff --git a/apps/examples/adc/adc_main.c b/apps/examples/adc/adc_main.c
index 8373684a4..b88032654 100644
--- a/apps/examples/adc/adc_main.c
+++ b/apps/examples/adc/adc_main.c
@@ -1,7 +1,7 @@
/****************************************************************************
* examples/adc/adc_main.c
*
- * Copyright (C) 2011 Gregory Nutt. All rights reserved.
+ * Copyright (C) 2011-2012 Gregory Nutt. All rights reserved.
* Author: Gregory Nutt <gnutt@nuttx.org>
*
* Redistribution and use in source and binary forms, with or without
@@ -44,6 +44,7 @@
#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>
+#include <string.h>
#include <fcntl.h>
#include <errno.h>
#include <debug.h>
@@ -76,6 +77,8 @@
* Private Data
****************************************************************************/
+static struct adc_state_s g_adcstate;
+
/****************************************************************************
* Public Data
****************************************************************************/
@@ -85,6 +88,137 @@
****************************************************************************/
/****************************************************************************
+ * Name: adc_devpath
+ ****************************************************************************/
+
+static void adc_devpath(FAR struct adc_state_s *adc, FAR const char *devpath)
+{
+ /* Get rid of any old device path */
+
+ if (adc->devpath)
+ {
+ free(adc->devpath);
+ }
+
+ /* Then set-up the new device path by copying the string */
+
+ adc->devpath = strdup(devpath);
+}
+
+/****************************************************************************
+ * Name: adc_help
+ ****************************************************************************/
+
+#ifdef CONFIG_NSH_BUILTIN_APPS
+static void adc_help(FAR struct adc_state_s *adc)
+{
+ message("Usage: adc [OPTIONS]\n");
+ message("\nArguments are \"sticky\". For example, once the ADC device is\n");
+ message("specified, that device will be re-used until it is changed.\n");
+ message("\n\"sticky\" OPTIONS include:\n");
+ message(" [-p devpath] selects the ADC device. "
+ "Default: %s Current: %s\n",
+ CONFIG_EXAMPLES_ADC_DEVPATH, g_adcstate.devpath ? g_adcstate.devpath : "NONE");
+ message(" [-n count] selects the samples to collect. "
+ "Default: 1 Current: %d\n", adc->count);
+ message(" [-h] shows this message and exits\n");
+}
+#endif
+
+/****************************************************************************
+ * Name: arg_string
+ ****************************************************************************/
+
+#ifdef CONFIG_NSH_BUILTIN_APPS
+static int arg_string(FAR char **arg, FAR char **value)
+{
+ FAR char *ptr = *arg;
+
+ if (ptr[2] == '\0')
+ {
+ *value = arg[1];
+ return 2;
+ }
+ else
+ {
+ *value = &ptr[2];
+ return 1;
+ }
+}
+#endif
+
+/****************************************************************************
+ * Name: arg_decimal
+ ****************************************************************************/
+
+#ifdef CONFIG_NSH_BUILTIN_APPS
+static int arg_decimal(FAR char **arg, FAR long *value)
+{
+ FAR char *string;
+ int ret;
+
+ ret = arg_string(arg, &string);
+ *value = strtol(string, NULL, 10);
+ return ret;
+}
+#endif
+
+/****************************************************************************
+ * Name: parse_args
+ ****************************************************************************/
+
+#ifdef CONFIG_NSH_BUILTIN_APPS
+static void parse_args(FAR struct adc_state_s *adc, int argc, FAR char **argv)
+{
+ FAR char *ptr;
+ FAR char *str;
+ long value;
+ int index;
+ int nargs;
+
+ for (index = 1; index < argc; )
+ {
+ ptr = argv[index];
+ if (ptr[0] != '-')
+ {
+ message("Invalid options format: %s\n", ptr);
+ exit(0);
+ }
+
+ switch (ptr[1])
+ {
+ case 'n':
+ nargs = arg_decimal(&argv[index], &value);
+ if (value < 0)
+ {
+ message("Count must be non-negative: %ld\n", value);
+ exit(1);
+ }
+
+ adc->count = (uint32_t)value;
+ index += nargs;
+ break;
+
+ case 'p':
+ nargs = arg_string(&argv[index], &str);
+ adc_devpath(adc, str);
+ index += nargs;
+ break;
+
+ case 'h':
+ adc_help(adc);
+ exit(0);
+
+ default:
+ message("Unsupported option: %s\n", ptr);
+ adc_help(adc);
+ exit(1);
+ }
+ }
+}
+#endif
+
+/****************************************************************************
* Public Functions
****************************************************************************/
@@ -97,50 +231,63 @@ int MAIN_NAME(int argc, char *argv[])
struct adc_msg_s sample[CONFIG_EXAMPLES_ADC_GROUPSIZE];
size_t readsize;
ssize_t nbytes;
-#if defined(CONFIG_NSH_BUILTIN_APPS) || defined(CONFIG_EXAMPLES_ADC_NSAMPLES)
- long nloops;
-#endif
int fd;
int errval = 0;
int ret;
int i;
- /* If this example is configured as an NX add-on, then limit the number of
- * samples that we collect before returning. Otherwise, we never return
- */
+ /* Check if we have initialized */
-#if defined(CONFIG_NSH_BUILTIN_APPS)
- nloops = 1;
- if (argc > 1)
+ if (!g_adcstate.initialized)
{
- nloops = strtol(argv[1], NULL, 10);
+ /* Initialization of the ADC hardware is performed by logic external to
+ * this test.
+ */
+
+ message(MAIN_STRING "Initializing external ADC device\n");
+ ret = adc_devinit();
+ if (ret != OK)
+ {
+ message(MAIN_STRING "adc_devinit failed: %d\n", ret);
+ errval = 1;
+ goto errout;
+ }
+
+ /* Set the default values */
+
+ adc_devpath(&g_adcstate, CONFIG_EXAMPLES_ADC_DEVPATH);
+
+#ifdef CONFIG_EXAMPLES_ADC_NSAMPLES
+ g_adcstate.count = CONFIG_EXAMPLES_ADC_NSAMPLES;
+#else
+ g_adcstate.count = 1;
+#endif
+ g_adcstate.initialized = true;
}
- message(MAIN_STRING "nloops: %d\n", nloops);
-#elif defined(CONFIG_EXAMPLES_ADC_NSAMPLES)
- message(MAIN_STRING "nloops: %d\n", CONFIG_EXAMPLES_ADC_NSAMPLES);
+
+ /* Parse the command line */
+
+#ifdef CONFIG_NSH_BUILTIN_APPS
+ parse_args(&g_adcstate, argc, argv);
#endif
- /* Initialization of the ADC hardware is performed by logic external to
- * this test.
+ /* If this example is configured as an NX add-on, then limit the number of
+ * samples that we collect before returning. Otherwise, we never return
*/
- message(MAIN_STRING "Initializing external ADC device\n");
- ret = adc_devinit();
- if (ret != OK)
- {
- message(MAIN_STRING "adc_devinit failed: %d\n", ret);
- errval = 1;
- goto errout;
- }
+#if defined(CONFIG_NSH_BUILTIN_APPS) || defined(CONFIG_EXAMPLES_ADC_NSAMPLES)
+ message(MAIN_STRING "g_adcstate.count: %d\n", g_adcstate.count);
+#endif
/* Open the ADC device for reading */
- message(MAIN_STRING "Hardware initialized. Opening the ADC device\n");
- fd = open(CONFIG_EXAMPLES_ADC_DEVPATH, O_RDONLY);
+ message(MAIN_STRING "Hardware initialized. Opening the ADC device: %s\n",
+ g_adcstate.devpath);
+
+ fd = open(g_adcstate.devpath, O_RDONLY);
if (fd < 0)
{
- message(MAIN_STRING "open %s failed: %d\n",
- CONFIG_EXAMPLES_ADC_DEVPATH, errno);
+ message(MAIN_STRING "open %s failed: %d\n", g_adcstate.devpath, errno);
errval = 2;
goto errout_with_dev;
}
@@ -150,9 +297,9 @@ int MAIN_NAME(int argc, char *argv[])
*/
#if defined(CONFIG_NSH_BUILTIN_APPS)
- for (; nloops > 0; nloops--)
+ for (; g_adcstate.count > 0; g_adcstate.count--)
#elif defined(CONFIG_EXAMPLES_ADC_NSAMPLES)
- for (nloops = 0; nloops < CONFIG_EXAMPLES_ADC_NSAMPLES; nloops++)
+ for (g_adcstate.count = 0; g_adcstate.count < CONFIG_EXAMPLES_ADC_NSAMPLES; g_adcstate.count++)
#else
for (;;)
#endif
@@ -176,7 +323,7 @@ int MAIN_NAME(int argc, char *argv[])
if (errval != EINTR)
{
message(MAIN_STRING "read %s failed: %d\n",
- CONFIG_EXAMPLES_ADC_DEVPATH, errval);
+ g_adcstate.devpath, errval);
errval = 3;
goto errout_with_dev;
}
diff --git a/apps/examples/pwm/pwm_main.c b/apps/examples/pwm/pwm_main.c
index 91f97aa75..64c5dfb2c 100644
--- a/apps/examples/pwm/pwm_main.c
+++ b/apps/examples/pwm/pwm_main.c
@@ -1,7 +1,7 @@
/****************************************************************************
* examples/pwm/pwm_main.c
*
- * Copyright (C) 2011 Gregory Nutt. All rights reserved.
+ * Copyright (C) 2011-2012 Gregory Nutt. All rights reserved.
* Author: Gregory Nutt <gnutt@nuttx.org>
*
* Redistribution and use in source and binary forms, with or without
@@ -63,13 +63,14 @@
struct pwm_state_s
{
- bool initialized;
- uint8_t duty;
- uint32_t freq;
+ bool initialized;
+ FAR char *devpath;
+ uint8_t duty;
+ uint32_t freq;
#ifdef CONFIG_PWM_PULSECOUNT
- uint32_t count;
+ uint32_t count;
#endif
- int duration;
+ int duration;
};
/****************************************************************************
@@ -91,6 +92,24 @@ static struct pwm_state_s g_pwmstate;
****************************************************************************/
/****************************************************************************
+ * Name: pwm_devpath
+ ****************************************************************************/
+
+static void pwm_devpath(FAR struct pwm_state_s *pwm, FAR const char *devpath)
+{
+ /* Get rid of any old device path */
+
+ if (pwm->devpath)
+ {
+ free(pwm->devpath);
+ }
+
+ /* Then set-up the new device path by copying the string */
+
+ pwm->devpath = strdup(devpath);
+}
+
+/****************************************************************************
* Name: pwm_help
****************************************************************************/
@@ -100,6 +119,9 @@ static void pwm_help(FAR struct pwm_state_s *pwm)
message("\nArguments are \"sticky\". For example, once the PWM frequency is\n");
message("specified, that frequency will be re-used until it is changed.\n");
message("\n\"sticky\" OPTIONS include:\n");
+ message(" [-p devpath] selects the PWM device. "
+ "Default: %s Current: %s\n",
+ CONFIG_EXAMPLES_PWM_DEVPATH, pwm->devpath ? pwm->devpath : "NONE");
message(" [-f addr] selects the pulse frequency. "
"Default: %d Hz Current: %d Hz\n",
CONFIG_EXAMPLES_PWM_FREQUENCY, pwm->freq);
@@ -158,6 +180,7 @@ static int arg_decimal(FAR char **arg, FAR long *value)
static void parse_args(FAR struct pwm_state_s *pwm, int argc, FAR char **argv)
{
FAR char *ptr;
+ FAR char *str;
long value;
int index;
int nargs;
@@ -211,6 +234,12 @@ static void parse_args(FAR struct pwm_state_s *pwm, int argc, FAR char **argv)
break;
#endif
+ case 'p':
+ nargs = arg_string(&argv[index], &str);
+ pwm_devpath(pwm, str);
+ index += nargs;
+ break;
+
case 't':
nargs = arg_decimal(&argv[index], &value);
if (value < 1 || value > INT_MAX)
@@ -266,6 +295,15 @@ int pwm_main(int argc, char *argv[])
parse_args(&g_pwmstate, argc, argv);
+ /* Has a device been assigned? */
+
+ if (!g_pwmstate.devpath)
+ {
+ /* No.. use the default device */
+
+ pwm_devpath(&g_pwmstate, CONFIG_EXAMPLES_PWM_DEVPATH);
+ }
+
/* Initialization of the PWM hardware is performed by logic external to
* this test.
*/
@@ -279,11 +317,10 @@ int pwm_main(int argc, char *argv[])
/* Open the PWM device for reading */
- fd = open(CONFIG_EXAMPLES_PWM_DEVPATH, O_RDONLY);
+ fd = open(g_pwmstate.devpath, O_RDONLY);
if (fd < 0)
{
- message("pwm_main: open %s failed: %d\n",
- CONFIG_EXAMPLES_PWM_DEVPATH, errno);
+ message("pwm_main: open %s failed: %d\n", g_pwmstate.devpath, errno);
goto errout;
}
@@ -335,8 +372,7 @@ int pwm_main(int argc, char *argv[])
/* Then stop the pulse train */
- message("pwm_main: stopping output\n",
- info.frequency, info.duty);
+ message("pwm_main: stopping output\n", info.frequency, info.duty);
ret = ioctl(fd, PWMIOC_STOP, 0);
if (ret < 0)
diff --git a/apps/examples/qencoder/qe.h b/apps/examples/qencoder/qe.h
index 1571da7b2..4c03689ab 100644
--- a/apps/examples/qencoder/qe.h
+++ b/apps/examples/qencoder/qe.h
@@ -100,9 +100,11 @@
#ifdef CONFIG_NSH_BUILTIN_APPS
struct qe_example_s
{
- bool reset; /* True: set the count back to zero */
- unsigned int nloops; /* Collect this number of samples */
- unsigned int delay; /* Delay this number of seconds between samples */
+ bool initialized; /* True: QE devices have been initialized */
+ bool reset; /* True: set the count back to zero */
+ FAR char *devpath; /* Path to the QE device */
+ unsigned int nloops; /* Collect this number of samples */
+ unsigned int delay; /* Delay this number of seconds between samples */
};
#endif
diff --git a/apps/examples/qencoder/qe_main.c b/apps/examples/qencoder/qe_main.c
index bf743d229..c58a2b0ad 100644
--- a/apps/examples/qencoder/qe_main.c
+++ b/apps/examples/qencoder/qe_main.c
@@ -45,6 +45,7 @@
#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>
+#include <string.h>
#include <fcntl.h>
#include <limits.h>
#include <errno.h>
@@ -91,6 +92,24 @@ struct qe_example_s g_qeexample;
****************************************************************************/
/****************************************************************************
+ * Name: qe_devpath
+ ****************************************************************************/
+
+static void qe_devpath(FAR const char *devpath)
+{
+ /* Get rid of any old device path */
+
+ if (g_qeexample.devpath)
+ {
+ free(g_qeexample.devpath);
+ }
+
+ /* The set-up the new device path by copying the string */
+
+ g_qeexample.devpath = strdup(devpath);
+}
+
+/****************************************************************************
* Name: qe_help
****************************************************************************/
@@ -99,6 +118,7 @@ static void qe_help(void)
{
message("\nUsage: qe [OPTIONS]\n\n");
message("OPTIONS include:\n");
+ message(" [-p devpath] QE device path\n");
message(" [-n samples] Number of samples\n");
message(" [-t msec] Delay between samples (msec)\n");
message(" [-r] Reset the position to zero\n");
@@ -152,6 +172,7 @@ static int arg_decimal(FAR char **arg, FAR long *value)
static void parse_args(int argc, FAR char **argv)
{
FAR char *ptr;
+ FAR char *str;
long value;
int index;
int nargs;
@@ -183,6 +204,12 @@ static void parse_args(int argc, FAR char **argv)
index += nargs;
break;
+ case 'p':
+ nargs = arg_string(&argv[index], &str);
+ qe_devpath(str);
+ index += nargs;
+ break;
+
case 't':
nargs = arg_decimal(&argv[index], &value);
if (value < 0 || value > INT_MAX)
@@ -231,33 +258,44 @@ int MAIN_NAME(int argc, char *argv[])
int nloops;
#endif
+ /* Check if we have initialized */
+
+ if (!g_qeexample.initialized)
+ {
+ /* Initialization of the encoder hardware is performed by logic external to
+ * this test.
+ */
+
+ message(MAIN_STRING "Initializing external encoder(s)\n");
+ ret = qe_devinit();
+ if (ret != OK)
+ {
+ message(MAIN_STRING "qe_devinit failed: %d\n", ret);
+ exitval = EXIT_FAILURE;
+ goto errout;
+ }
+
+ /* Set the default values */
+
+ qe_devpath(CONFIG_EXAMPLES_QENCODER_DEVPATH);
+ g_qeexample.initialized = true;
+ }
+
/* Parse command line arguments */
#ifdef CONFIG_NSH_BUILTIN_APPS
parse_args(argc, argv);
#endif
- /* Initialization of the encoder hardware is performed by logic external to
- * this test.
- */
-
- message(MAIN_STRING "Initializing external encoder\n");
- ret = qe_devinit();
- if (ret != OK)
- {
- message(MAIN_STRING "qe_devinit failed: %d\n", ret);
- exitval = EXIT_FAILURE;
- goto errout;
- }
-
/* Open the encoder device for reading */
- message(MAIN_STRING "Hardware initialized. Opening the encoder device\n");
- fd = open(CONFIG_EXAMPLES_QENCODER_DEVPATH, O_RDONLY);
+ message(MAIN_STRING "Hardware initialized. Opening the encoder device: %s\n",
+ g_qeexample.devpath);
+
+ fd = open(g_qeexample.devpath, O_RDONLY);
if (fd < 0)
{
- message(MAIN_STRING "open %s failed: %d\n",
- CONFIG_EXAMPLES_QENCODER_DEVPATH, errno);
+ message(MAIN_STRING "open %s failed: %d\n", g_qeexample.devpath, errno);
exitval = EXIT_FAILURE;
goto errout_with_dev;
}
diff --git a/nuttx/arch/arm/src/stm32/stm32_qencoder.c b/nuttx/arch/arm/src/stm32/stm32_qencoder.c
index 237782c15..8553296f9 100644
--- a/nuttx/arch/arm/src/stm32/stm32_qencoder.c
+++ b/nuttx/arch/arm/src/stm32/stm32_qencoder.c
@@ -124,7 +124,7 @@
/* If TIM1,3,4, or 8 are enabled, then we have 16-bit timers */
# if defined(CONFIG_STM32_TIM1_QE) || defined(CONFIG_STM32_TIM3_QE) || \
-# defined(CONFIG_STM32_TIM4_QE) || defined(CONFIG_STM32_TIM8_QE)
+ defined(CONFIG_STM32_TIM4_QE) || defined(CONFIG_STM32_TIM8_QE)
# define HAVE_16BIT_TIMERS 1
# endif
@@ -734,8 +734,10 @@ static int stm32_setup(FAR struct qe_lowerhalf_s *lower)
uint16_t ccmr1;
uint16_t ccer;
uint16_t cr1;
+#ifdef HAVE_16BIT_TIMERS
uint16_t regval;
int ret;
+#endif
/* NOTE: Clocking should have been enabled in the low-level RCC logic at boot-up */
diff --git a/nuttx/configs/stm3210e-eval/src/up_pmbuttons.c b/nuttx/configs/stm3210e-eval/src/up_pmbuttons.c
index 35a98a00a..c0f16ee8c 100644
--- a/nuttx/configs/stm3210e-eval/src/up_pmbuttons.c
+++ b/nuttx/configs/stm3210e-eval/src/up_pmbuttons.c
@@ -187,9 +187,9 @@ static const xcpt_t g_buttonhandlers[NUM_PMBUTTONS] =
#endif
#if MAX_BUTTON > 6
button7_handler,
- }
#endif
};
+#endif /* CONFIG_ARCH_IRQBUTTONS */
/****************************************************************************
* Private Functions